|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttributeCollection
An AttributeCollection is a collection of Attribute Definitions. These attribute definitions can be specified individually, or a Spec can be imported as a dynamic source of Attribute Definitions, so that if the Spec changes, the AttributeCollection will automatically reflect the changes. Attribute Collections are typically used in the following places:
WorkflowStep
,
Catalog
,
Hierarchy
,
Role
,
An Attribute Collection can be restricted to a certain set of locales. By
default, there is no locale restriction in effect.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addAllAttributes(java.util.Collection<AttributeDefinition> attributeDefinitions)
Adds all attribute defintions in a collection of AttributeDefinitions to this AttributeCollection, All attribute definitions of the collection will be added to the attribute collection. |
void |
addAllAttributes(Spec spec)
Adds all the attribute definitions from a Spec to the attribute collection. |
void |
addAttribute(AttributeDefinition attributeDefinition)
Adds an attribute to the attribute collection by specifying a AttributeDefinition. |
void |
addAttribute(java.lang.String attributeDefinitionPath)
Adds an attribute to the attribute collection by specifying the path to the AttributeDefinition. |
void |
addLocaleRestriction(java.util.Locale locale)
Adds a locale as a restricted locale for this attribute collection. |
void |
addSpec(Spec spec)
Adds a Spec to the attribute collection as a dynamic source of attributes. |
boolean |
contains(AttributeDefinition attributeDefinition)
Checks if an attribute definition is present in this attribute collection. |
boolean |
contains(java.lang.String attributeDefinitionPath)
Checks if an attribute definition is present in this attribute collection. |
void |
delete()
Deletes the attribute collection. |
java.util.Collection<AttributeDefinition> |
getAttributes()
Returns all current list of attributes in this attribute collection. |
java.lang.String |
getDescription()
Returns the description of this attribute collection. |
java.util.Collection<java.util.Locale> |
getLocaleRestrictions()
Returns the locales to which this attribute collection is restricted. |
java.lang.String |
getName()
Returns the name of this attribute collection. |
java.util.Collection<Spec> |
getSpecs()
Get all of the specs associated with this attribute collection as dynamic sources of attributes. |
boolean |
isGenerated()
Identifies whether this is a generated attribute collection |
void |
removeAllAttributes(Spec specWithAttributesToRemove)
Removes all the attributes of the spec from this attribute collection. |
void |
removeAttribute(AttributeDefinition attributeDefinition)
Removes an attribute from the attribute collection by specifying the AttributeDefinition. |
void |
removeAttribute(java.lang.String attributeDefinitionPath)
Removes an attribute from the attribute collection by specifying the path to the AttributeDefinition. |
void |
removeLocaleRestriction(java.util.Locale locale)
Removes a locale as a restricted locale for this attribute collection. |
void |
removeSpec(Spec specToRemove)
Removes a spec from this attribute collections list of dynamic attribute sources. |
void |
save()
Saves the attribute collection. |
void |
setDescription(java.lang.String description)
Sets or changes the description of this attribute collection. |
void |
setLocaleRestrictions(java.util.Collection<java.util.Locale> locales)
Sets the locale restrictions for this attribute collection. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
boolean isGenerated()
PIMInternalException
- if an internal error occurs
java.lang.IllegalStateException
- if the AttributeCollection has not been savedboolean contains(java.lang.String attributeDefinitionPath)
attributeDefinitionPath
- the path of the attribute definition to check for
java.lang.IllegalArgumentException
- if attributeDefinitionPath is null or invalid
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or the
identified AttributeDefinition belongs to a Spec which has
not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer existsboolean contains(AttributeDefinition attributeDefinition)
attributeDefinition
- the attribute definition to check for
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or
attributeDefinition belongs to a Spec which has not been
saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer existsvoid addAttribute(AttributeDefinition attributeDefinition)
attributeDefinition
- the AttributeDefinition describing the attribute to be added.
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if the AttributeDefinition is already present in this
AttributeCollection
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or
attributeDefinition belongs to a Spec which has not been
saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid addAttribute(java.lang.String attributeDefinitionPath)
attributeDefinitionPath
- the path to an existing AttributeDefinition which is to be
added
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if attributeDefinitionPath is null or invalid, or if the
identified AttributeDefinition is already present in this
AttributeCollection
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or the
identified AttributeDefinition belongs to a Spec which has
not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid removeAttribute(AttributeDefinition attributeDefinition)
attributeDefinition
- the AttributeDefinition describing the attribute to be removed
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if attributeDefinition is not present in this
AttributeCollection
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or
attributeDefinition belongs to a Spec which has not been
saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid removeAttribute(java.lang.String attributeDefinitionPath)
attributeDefinitionPath
- path to an existing attribute which has been added.
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if attributeDefinitionPath is null or invalid, or if the
identified AttributeDefinition is not present in this
AttributeCollection
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or the
identified AttributeDefinition belongs to a Spec which has
not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid delete()
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalStateException
- if the AttributeCollection has not been saved
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists, or if delete is not possible (for example, the
attribute collection is in use in container access privileges
or views)
PIMAuthorizationException
- Reserved for future usevoid save()
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
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 usejava.lang.String getName()
java.lang.IllegalStateException
- if the AttributeCollection has not been saved
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer existsjava.lang.String getDescription()
java.lang.IllegalStateException
- if the AttributeCollection has not been saved
PIMInternalException
- if an internal error occurs, or the AttributeCollectionvoid setDescription(java.lang.String description)
description
- the description for this attribute collection, which may be
null
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid addSpec(Spec spec)
spec
- the spec to add
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if spec is already present in this AttributeCollection
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or spec has
not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid addAllAttributes(Spec spec)
spec
- the spec to add
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if spec is already present in this AttributeCollection as a
dynamic source of attributes
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or spec has
not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid addAllAttributes(java.util.Collection<AttributeDefinition> attributeDefinitions)
attributeDefinitions
- the collection of AttributeDefinitions to be added
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if attributeDefinitions is null
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or any of the
attribute definitions belongs to a spec which has not been
saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usejava.util.Collection<AttributeDefinition> getAttributes()
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 usejava.util.Collection<Spec> getSpecs()
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 usevoid removeSpec(Spec specToRemove)
specToRemove
- a spec which has been added as Dynamic Attribute Source of
attributes, and is to be removed.
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if spec is not present in this AttributeCollection as a
dynamic source of attributes
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or spec has
not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usevoid removeAllAttributes(Spec specWithAttributesToRemove)
specWithAttributesToRemove
- a spec whose full list of attributes will be removed from this
Attribute collection.
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if spec is present in this AttributeCollection as a dynamic
source of attributes
java.lang.IllegalStateException
- if the AttributeCollection has not been saved, or spec has
not been saved.
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer exists
PIMAuthorizationException
- Reserved for future usejava.util.Collection<java.util.Locale> getLocaleRestrictions()
java.lang.IllegalStateException
- if the AttributeCollection has not been saved
PIMInternalException
- if an internal error occurs, or the AttributeCollection no
longer existsvoid addLocaleRestriction(java.util.Locale locale)
locale
- the locale to be added
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if locale is already present for this AttributeCollection, or
if the locale is not in the list of available locales.
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 usevoid removeLocaleRestriction(java.util.Locale locale)
locale
- the locale to be removed
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if locale is not present for this AttributeCollection
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 usevoid setLocaleRestrictions(java.util.Collection<java.util.Locale> locales)
locales
- a collection of locales to be applied as restrictions to this
attribute collection
java.lang.UnsupportedOperationException
- if the AttributeCollection is generated.
java.lang.IllegalArgumentException
- if locales 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 |