|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttributeCollectionManager
Manager for the creation and retrieval of AttributeCollections
Field Summary |
---|
Fields inherited from interface com.ibm.pim.common.Manager |
---|
copyright |
Method Summary | |
---|---|
AttributeCollection |
createAttributeCollection(java.lang.String name)
Creates an empty attribute collection with the specified name. |
AttributeCollection |
getAttributeCollection(java.lang.String name)
Retrieves an attribute collection by name |
java.util.Collection<AttributeCollection> |
getAttributeCollections()
Gets all AttributeCollections available in the current context. |
java.util.Collection<AttributeCollection> |
getAttributeCollections(AttributeDefinition attributeDefinition)
Returns all attribute collections that currently contain the specified AttributeDefinition. |
java.util.Collection<AttributeCollection> |
getAttributeCollections(Spec spec)
Gets all attribute collections that currently contain the specified Spec as a dynamic attribute source. |
java.util.Collection<AttributeCollection> |
getAttributeCollections(java.lang.String attributeDefinitionPath)
Gets all attribute collections that currently contain the specified AttributeDefinition, as specified by its path. |
Methods inherited from interface com.ibm.pim.common.Manager |
---|
getManagerName |
Method Detail |
---|
java.util.Collection<AttributeCollection> getAttributeCollections()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- Reserved for future useAttributeCollection createAttributeCollection(java.lang.String name)
name
- the name for the attribute collection
java.lang.IllegalArgumentException
- if name is null or an empty string
PIMInternalException
- if an internal error occurs, or if an attribute collection
already exists by this name.
PIMAuthorizationException
- Reserved for future usejava.util.Collection<AttributeCollection> getAttributeCollections(AttributeDefinition attributeDefinition)
attributeDefinition
- the attribute definition for which to retrieve attribute
collections
java.lang.IllegalArgumentException
- if attributeDefinition is null
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or if
attributeDefinition belongs to a spec that has not been
saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usejava.util.Collection<AttributeCollection> getAttributeCollections(java.lang.String attributeDefinitionPath)
attributeDefinitionPath
- the path to the attribute to retrieve attribute collections
for
java.lang.IllegalArgumentException
- if attributeDefinition is null or invalid
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or if the
identified attributeDefinition belongs to a spec that has not
been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMInvalidPathException
- if the attribute definition path is invalid
PIMAuthorizationException
- Reserved for future usejava.util.Collection<AttributeCollection> getAttributeCollections(Spec spec)
spec
- the spec to retrieve attribute collections for
java.lang.IllegalArgumentException
- if spec is null
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or if spec
that has not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future useAttributeCollection getAttributeCollection(java.lang.String name)
name
- the name of the attribute collection to return
java.lang.IllegalArgumentException
- if name is null
java.lang.IllegalStateException
- if the AttributeCollection has not been saved
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future use
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |