Operation (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.Operation

All Implemented Interfaces:

Serializable, Comparable<Operation>

Direct Known Subclasses:

DelOperation, DoOperation, GetOperation, PushOperation, SetOperation
```
public abstract class Operation
extends Object
implements Serializable, Comparable<Operation>
```
An XDI messaging operation, represented as a relation.

Author:

markus

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Message message

protected Relation relation

Fields
Modifier and Type	Field and Description
`protected Message`	`message`
`protected Relation`	`relation`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Operation(Message message, Relation relation)

Constructors
Modifier	Constructor and Description
`protected`	`Operation(Message message, Relation relation)`

Method Summary

Methods
Modifier and Type	Method and Description
`static Operation`	`castOperation(Operation operation)` Factory method that casts an Operation to the right subclass, e.g. to a GetOperation.
`int`	`compareTo(Operation other)`
`boolean`	`equals(Object object)`
`static Operation`	`fromMessageAndRelation(Message message, Relation relation)` Factory method that creates an XDI operation bound to a given relation.
`Message`	`getMessage()` Returns the XDI message to which this XDI operation belongs.
`MessageCollection`	`getMessageCollection()` Returns the XDI message collection to which this XDI operation belongs.
`MessageEnvelope`	`getMessageEnvelope()` Returns the XDI message envelope to which this XDI operation belongs.
`XDIAddress`	`getOperationXDIAddress()` Returns the operation XRI of the XDI operation (e.g.
`Object`	`getParameter(XDIAddress parameterAddress)` Returns a parameter value of this operation.
`Boolean`	`getParameterBoolean(XDIAddress parameterAddress)` Returns a parameter value boolean of this operation.
`Number`	`getParameterNumber(XDIAddress parameterAddress)` Returns a parameter value number of this operation.
`String`	`getParameterString(XDIAddress parameterAddress)` Returns a parameter value string of this operation.
`Relation`	`getRelation()` Returns the underlying relation to which this XDI operation is bound.
`ContextNode`	`getSender()` Returns the sender of the operation's message collection.
`XDIAddress`	`getSenderXDIAddress()` Returns the sender address of the operation's message collection.
`XdiInnerRoot`	`getTargetInnerRoot()` Returns the target inner root of the operation.
`XDIAddress`	`getTargetXDIAddress()` Returns the target address of the operation.
`Iterator<XDIStatement>`	`getTargetXDIStatements()` Returns the target statements of the operation.
`int`	`hashCode()`
`boolean`	`isReadOnlyOperation()` Is this a read-only operation?
`static boolean`	`isValid(Relation relation)` Checks if an relation is a valid XDI operation.
`void`	`setParameter(XDIAddress parameterAddress, Object parameterValue)` Sets a parameter value of this operation.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - message
```
protected Message message
```
  - relation
```
protected Relation relation
```
- Constructor Detail
  - Operation
```
protected Operation(Message message,
         Relation relation)
```
- Method Detail
  - isValid
```
public static boolean isValid(Relation relation)
```
    Checks if an relation is a valid XDI operation.
    
    Parameters:
    relation - The relation to check.
    
    Returns:
    True if the relation is a valid XDI operation.
  - fromMessageAndRelation
```
public static Operation fromMessageAndRelation(Message message,
                               Relation relation)
```
    Factory method that creates an XDI operation bound to a given relation.
    
    Parameters:
    message - The XDI message to which this XDI operation belongs.
    relation - The relation that is an XDI operation.
    
    Returns:
    The XDI operation.
  - castOperation
```
public static Operation castOperation(Operation operation)
```
    Factory method that casts an Operation to the right subclass, e.g. to a GetOperation.
    
    Parameters:
    operation - The Operation to be cast.
    
    Returns:
    The casted Operation.
  - getMessage
```
public Message getMessage()
```
    Returns the XDI message to which this XDI operation belongs.
    
    Returns:
    An XDI message.
  - getMessageCollection
```
public MessageCollection getMessageCollection()
```
    Returns the XDI message collection to which this XDI operation belongs.
    
    Returns:
    An XDI message collection.
  - getMessageEnvelope
```
public MessageEnvelope getMessageEnvelope()
```
    Returns the XDI message envelope to which this XDI operation belongs.
    
    Returns:
    An XDI message envelope.
  - getRelation
```
public Relation getRelation()
```
    Returns the underlying relation to which this XDI operation is bound.
    
    Returns:
    A relation that represents the XDI operation.
  - getOperationXDIAddress
```
public XDIAddress getOperationXDIAddress()
```
    Returns the operation XRI of the XDI operation (e.g. $get, $mod).
    
    Returns:
    The operation XRI of the XDI operation.
  - getTargetInnerRoot
```
public XdiInnerRoot getTargetInnerRoot()
```
    Returns the target inner root of the operation.
    
    Returns:
    The target inner root of the operation.
  - getTargetXDIAddress
```
public XDIAddress getTargetXDIAddress()
```
    Returns the target address of the operation.
    
    Returns:
    The target address of the operation.
  - getTargetXDIStatements
```
public Iterator<XDIStatement> getTargetXDIStatements()
```
    Returns the target statements of the operation.
    
    Returns:
    The target statements of the operation.
  - getSender
```
public ContextNode getSender()
```
    Returns the sender of the operation's message collection.
    
    Returns:
    The sender of the operation's message collection.
  - getSenderXDIAddress
```
public XDIAddress getSenderXDIAddress()
```
    Returns the sender address of the operation's message collection.
    
    Returns:
    The sender address of the operation's message collection.
  - isReadOnlyOperation
```
public boolean isReadOnlyOperation()
```
    Is this a read-only operation?
  - setParameter
```
public void setParameter(XDIAddress parameterAddress,
                Object parameterValue)
```
    Sets a parameter value of this operation.
    
    Parameters:
    parameterAddress - The parameter XRI.
    parameterValue - The parameter value.
  - getParameter
```
public Object getParameter(XDIAddress parameterAddress)
```
    Returns a parameter value of this operation.
    
    Parameters:
    parameterAddress - The parameter XRI.
    
    Returns:
    The parameter value.
  - getParameterString
```
public String getParameterString(XDIAddress parameterAddress)
```
    Returns a parameter value string of this operation.
    
    Parameters:
    parameterAddress - The parameter XRI.
    
    Returns:
    The parameter value string.
  - getParameterNumber
```
public Number getParameterNumber(XDIAddress parameterAddress)
```
    Returns a parameter value number of this operation.
    
    Parameters:
    parameterAddress - The parameter XRI.
    
    Returns:
    The parameter value number.
  - getParameterBoolean
```
public Boolean getParameterBoolean(XDIAddress parameterAddress)
```
    Returns a parameter value boolean of this operation.
    
    Parameters:
    parameterAddress - The parameter XRI.
    
    Returns:
    The parameter value boolean.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Operation other)
```
    Specified by:
    
    compareTo in interface Comparable<Operation>

Class Operation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

message

relation

Constructor Detail

Operation

Method Detail

isValid

fromMessageAndRelation

castOperation

getMessage

getMessageCollection

getMessageEnvelope

getRelation

getOperationXDIAddress

getTargetInnerRoot

getTargetXDIAddress

getTargetXDIStatements

getSender

getSenderXDIAddress

isReadOnlyOperation

setParameter

getParameter

getParameterString

getParameterNumber

getParameterBoolean

toString

equals

hashCode

compareTo