com.filenet.api.action
Class ApplySecurityTemplate

java.lang.Object
  extended by com.filenet.api.action.PendingAction
      extended by com.filenet.api.action.ApplySecurityTemplate
All Implemented Interfaces:
java.io.Serializable

public class ApplySecurityTemplate
extends PendingAction

Represents an “apply security template” pending action. Calling a method that applies a security template to an object automatically creates an instance of ApplySecurityTemplate, which is then added to the underlying object’s PendingActions collection.

See Also:
Serialized Form

Constructor Summary
ApplySecurityTemplate(Id applyStateId)
          Creates a new instance of an ApplySecurityTemplate pending action object initialized with the specified versioning state identifier.
 
Method Summary
 Id getApplyStateId()
          Returns an identifier for the versioning state to be applied to the underlying object for this pending action.
 
Methods inherited from class com.filenet.api.action.PendingAction
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ApplySecurityTemplate

public ApplySecurityTemplate(Id applyStateId)
Creates a new instance of an ApplySecurityTemplate pending action object initialized with the specified versioning state identifier.

For a versioning security template, valid versioning state identifiers are:

For an application security template, the returned value corresponds to a user-defined ID managed by your application.

Parameters:
applyStateId - The ID of the versioning state identifier.
Method Detail

getApplyStateId

public Id getApplyStateId()
Returns an identifier for the versioning state to be applied to the underlying object for this pending action.

Returns:
The ID of the versioning state identifier.


© Copyright IBM Corporation 2006, 2008. All rights reserved.