com.ibm.ram.client
Class RAMAction

java.lang.Object
  extended by com.ibm.ram.common.data.Action
      extended by com.ibm.ram.client.RAMAction

public class RAMAction
extends Action

Describes the action to be performed on an object during a RAMSession.put (IRAMSessionObject ...). Use the constants to define actions that are to be performed. Pass the RAMAction to an IRAMSessionObject.setAction(...) and call RAMSession.put (IRAMSessionObject ...) to perform the action.

Since:
7.1
Author:
kbauer

Field Summary
static RAMAction ARCHIVE
          Action is only valid for assets in legacy review processes, use RAMAsset.getAvailableActions() for lifecycles.
static RAMAction CREATE
          For internal use only, use RAMSession.createAsset(Asset, RAMStatusMonitor) for the public API.
static RAMAction CREATE_AS_IS
          Action is only valid for assets in legacy review processes.
static RAMAction CREATE_DRAFT
          Action is only valid for assets in legacy review processes.
static RAMAction DELETE
          This action can be used to delete both legacy and lifecycle assets.
static java.lang.String LIFECYCLE_PRE_RETIRE_ACTION_IDENTIFIER
          Use in conjunction with RAMAsset.getAvailableActions() to retrieve the built in pre-retire action for lifecycles.
static java.lang.String LIFECYCLE_RETIRE_ACTION_IDENTIFIER
          Use in conjunction with RAMAsset.getAvailableActions() to retrieve the built in retire action for lifecycles.
static RAMAction RETIRE
          Action is only valid for assets in legacy review processes, use RAMAsset.getAvailableActions() for lifecycles.
static RAMAction REVERSION
          For internal use only, use RAMSession.createAssetNewVersion(Asset, String, RAMStatusMonitor) for the public API.
static RAMAction UPDATE
          For internal use only, use RAMSession.put(IRAMSessionObject, IProgressMonitor) for the public API.
static RAMAction UPDATE_AS_IS
          Action is only valid for assets in legacy review processes.
static RAMAction UPDATE_DRAFT
          Action is only valid for assets in legacy review processes.
 
Constructor Summary
RAMAction(int id, java.lang.String name)
           
 
Method Summary
 java.lang.String getIdentifier()
           
 java.lang.String getWorkflowId()
           
 java.lang.String toString()
           
 
Methods inherited from class com.ibm.ram.common.data.Action
getName, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LIFECYCLE_PRE_RETIRE_ACTION_IDENTIFIER

public static final java.lang.String LIFECYCLE_PRE_RETIRE_ACTION_IDENTIFIER
Use in conjunction with RAMAsset.getAvailableActions() to retrieve the built in pre-retire action for lifecycles.

See Also:
Constant Field Values

LIFECYCLE_RETIRE_ACTION_IDENTIFIER

public static final java.lang.String LIFECYCLE_RETIRE_ACTION_IDENTIFIER
Use in conjunction with RAMAsset.getAvailableActions() to retrieve the built in retire action for lifecycles.

See Also:
Constant Field Values

CREATE

public static final RAMAction CREATE
For internal use only, use RAMSession.createAsset(Asset, RAMStatusMonitor) for the public API.


UPDATE

public static final RAMAction UPDATE
For internal use only, use RAMSession.put(IRAMSessionObject, IProgressMonitor) for the public API.


DELETE

public static final RAMAction DELETE
This action can be used to delete both legacy and lifecycle assets.


REVERSION

public static final RAMAction REVERSION
For internal use only, use RAMSession.createAssetNewVersion(Asset, String, RAMStatusMonitor) for the public API.


CREATE_DRAFT

public static final RAMAction CREATE_DRAFT
Action is only valid for assets in legacy review processes.


UPDATE_DRAFT

public static final RAMAction UPDATE_DRAFT
Action is only valid for assets in legacy review processes.


CREATE_AS_IS

public static final RAMAction CREATE_AS_IS
Action is only valid for assets in legacy review processes.


UPDATE_AS_IS

public static final RAMAction UPDATE_AS_IS
Action is only valid for assets in legacy review processes.


ARCHIVE

public static final RAMAction ARCHIVE
Action is only valid for assets in legacy review processes, use RAMAsset.getAvailableActions() for lifecycles.


RETIRE

public static final RAMAction RETIRE
Action is only valid for assets in legacy review processes, use RAMAsset.getAvailableActions() for lifecycles.

Constructor Detail

RAMAction

public RAMAction(int id,
                 java.lang.String name)
Method Detail

getIdentifier

public java.lang.String getIdentifier()
Returns:
Returns the identifier.
Since:
7.2

getWorkflowId

public java.lang.String getWorkflowId()
Returns:
Returns the workflow id.
Since:
7.2

toString

public java.lang.String toString()
Overrides:
toString in class Action