com.ibm.itim.dataservices.model
Interface ManagableProfile

All Known Implementing Classes:
EntityLifecycleProfile, LifecycleProfile, ObjectProfile, ObjectProfileCategory, ServiceProfile

public interface ManagableProfile

This interface provides supports to allow customization of lifecycle management for entities Lifecycle management on the entities are defined in terms of operations on the entities. Operation names are case-insensitive and may not be overloaded for different parameters.


Method Summary
 void addOperation(ObjectProfileOperation oper)
          Adds a new operation to the list of supported operations for the entity
 void addRule(LifecycleRule rule)
          Adds a new lifecycle rule to the list of supported lifecycle rules for the profile
 DistinguishedName getDistinguishedName()
          Returns the distinguished name of the object if there is any
 java.lang.String getName()
          Returns the name of the object
 ObjectProfileOperation getOperation(java.lang.String name)
          Returns a specific operation by name
 java.util.Collection getOperationNames()
          Returns the supported operations for the entity
 java.util.Collection getOperations()
          Returns the supported operations for the entity
 LifecycleRule getRule(long ruleID)
          Returns the supported lifecycle rules for the profile for a given id.
 java.util.Collection getRules()
          Returns the supported lifecycle rules for the profile
 void removeOperation(java.lang.String operationName)
          Removes an operation from the list of supported operations
 void removeRule(long ruleID)
          Removes the supported rules for the profile
 void setOperation(ObjectProfileOperation oper)
          Modifies a specific operation by name
 void setOperations(java.util.Collection operations)
          Sets the supported operations for the entity
 void setRule(LifecycleRule rule)
          Sets the supported rule for the profile.
 void setRules(java.util.Collection rules)
          Sets the supported rules for the profile.
 

Method Detail

getDistinguishedName

DistinguishedName getDistinguishedName()
Returns the distinguished name of the object if there is any

Returns:
DistinguishedName of the object.

getName

java.lang.String getName()
Returns the name of the object

Returns:
String name of the object

getOperations

java.util.Collection getOperations()
Returns the supported operations for the entity

Returns:
Collection of operations.

getOperationNames

java.util.Collection getOperationNames()
Returns the supported operations for the entity

Returns:
Collection of operation names (Strings).

getOperation

ObjectProfileOperation getOperation(java.lang.String name)
Returns a specific operation by name

Parameters:
name - The name of the operation
Returns:
ObjectProfileOperation

setOperations

void setOperations(java.util.Collection operations)
                   throws java.lang.ClassCastException
Sets the supported operations for the entity

Parameters:
operations - Collection of supported ObjectProfileOperation
Throws:
java.lang.ClassCastException

addOperation

void addOperation(ObjectProfileOperation oper)
Adds a new operation to the list of supported operations for the entity

Parameters:
oper - Operation name to add.

setOperation

void setOperation(ObjectProfileOperation oper)
                  throws ObjectNotFoundException
Modifies a specific operation by name

Parameters:
oper - The new operation definition
Throws:
ObjectNotFoundException

removeOperation

void removeOperation(java.lang.String operationName)
                     throws ObjectNotFoundException,
                            ModelException
Removes an operation from the list of supported operations

Parameters:
operationName - Operation name to remove.
Throws:
ObjectNotFoundException
ModelException

getRules

java.util.Collection getRules()
Returns the supported lifecycle rules for the profile

Returns:
Collection of LifecycleRule

setRules

void setRules(java.util.Collection rules)
              throws java.lang.ClassCastException
Sets the supported rules for the profile. A new identification number is generated for all lifecycle rules.

Parameters:
rules - The Collection of supported LifecycleRule
Throws:
java.lang.ClassCastException

setRule

void setRule(LifecycleRule rule)
Sets the supported rule for the profile.

Parameters:
rule - A modified lifecycle rule.

getRule

LifecycleRule getRule(long ruleID)
Returns the supported lifecycle rules for the profile for a given id.

Parameters:
ruleID - the identification number of the lifecycle rule. The identification number is obtained from getRules().
Returns:
LifecycleRule lifecycle rule for a given ruleID.

addRule

void addRule(LifecycleRule rule)
Adds a new lifecycle rule to the list of supported lifecycle rules for the profile

Parameters:
rule - A new lifecycle rule.

removeRule

void removeRule(long ruleID)
                throws ObjectNotFoundException
Removes the supported rules for the profile

Parameters:
ruleID - identifier of supported LifecycleRule
Throws:
ObjectNotFoundException - Thrown if unable to locate the lifecycle rule.


IBM Security Identity Manager 6.0.0
© Copyright International Business Machines Corporation 2007, 2012. All rights reserved. US Government Users Restricited Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.