org.assistments.service.manager.core

Interface ObjectPropertyManager

All Known Implementing Classes:

ObjectPropertyManagerImpl

public interface ObjectPropertyManager

The PropertyManager allows a partner application or service to define a set of partner-specific properties.

Method Summary

Modifier and Type	Method and Description
ObjectProperty	createOrUpdateProperty(ObjectPropertyDefinition definition) Creates a new property (or updates an existing one) with the given information.
void	createOrUpdatePropertyExposure(java.lang.String propertyName, boolean exposed, boolean editable, java.lang.String category) Create or update the property exposure settings
void	deleteValue(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.lang.String propertyName) For a target object, removes the value.
void	disableProperty(java.lang.String propertyName) Set the is_Active property of a given property to false.
void	enableProperty(java.lang.String propertyName) Enable a property.
ObjectProperty	getDefaultValue(java.lang.String propertyName) Return the default value for the requested property
java.util.List<ObjectProperty>	getDefaultValues(java.util.List<java.lang.String> propertyNames) Return the default values for the requested properties
java.util.List<ObjectProperty>	getPropertiesWithNoValue() Return the object properties for properties that have no value.
ObjectProperty	getValue(XInfo targetXinfo, java.lang.String propertyName, ObjectPropertyTargetType targetType) Get the ObjectProperty for a particular target with the given propertyName.
ObjectProperty	getValue(XInfo targetXinfo, java.lang.String propertyName, ObjectPropertyTargetType targetType, java.util.List<XInfo> groupContext) Get the ObjectProperty for a particular target with the given propertyName.
java.util.List<ObjectProperty>	getValues(XInfo targetXinfo, ObjectPropertyTargetType targetType) Works like getValues(XInfo, ObjectPropertyTargetType, List) except there is no group context.
java.util.List<ObjectProperty>	getValues(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.util.List<XInfo> groupContext) Get the ObjectProperties for a particular target.
java.util.List<ObjectProperty>	getValuesByName(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.util.List<java.lang.String> propertyNames) Works like getValuesByName(XInfo, ObjectPropertyTargetType, List, List) except there is no group context.
java.util.List<ObjectProperty>	getValuesByName(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.util.List<XInfo> groupContext, java.util.List<java.lang.String> propertyNames) Get the ObjectProperties for the given target with the given propertyNames.
java.util.List<ObjectProperty>	getValuesByTarget(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.util.List<ObjectPropertyTargetType> definitionTargets) Works like getValuesByTarget(XInfo, ObjectPropertyTargetType, List, List) except there is no groupContext.
java.util.List<ObjectProperty>	getValuesByTarget(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.util.List<XInfo> groupContext, java.util.List<ObjectPropertyTargetType> definitionTargets) Get the ObjectProperties for a particular target where each property applies to one of the given definitionTargets.
java.util.List<ObjectProperty>	getValuesByTarget(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.util.List<XInfo> groupContext, ObjectPropertyTargetType definitionTarget) Works like getValuesByTarget(XInfo, ObjectPropertyTargetType, List, List) with a single definitionTarget.
java.util.List<ObjectProperty>	getValuesByTarget(XInfo targetXinfo, ObjectPropertyTargetType targetType, ObjectPropertyTargetType definitionTarget) Works like getValuesByTarget(XInfo, ObjectPropertyTargetType, List) with a single definitionTarget.
boolean	setValue(XInfo targetXinfo, ObjectPropertyTargetType targetType, java.lang.String propertyName, java.lang.Object value) For a target object, sets a value.
boolean	setValue(XInfo targetXinfo, ObjectPropertyTargetType targetType, XInfo setterXinfo, java.lang.String propertyName, java.lang.Object value) For a target object, sets a value.

Method Detail

createOrUpdateProperty

ObjectProperty createOrUpdateProperty(ObjectPropertyDefinition definition)

Creates a new property (or updates an existing one) with the given information.

Parameters:

definition - the definition for the property

Returns:

The ObjectProperty for this new property.

setValue

boolean setValue(XInfo targetXinfo,
                 ObjectPropertyTargetType targetType,
                 XInfo setterXinfo,
                 java.lang.String propertyName,
                 java.lang.Object value)
          throws NotFoundException

For a target object, sets a value.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the targetType of the object of interest.

setterXinfo - the external reference info for the person actually setting this value. (Optional)

propertyName - The property name

value - The property value

Returns:

true if the value was set

Throws:

NotFoundException - If the target object or property is not found

setValue

boolean setValue(XInfo targetXinfo,
                 ObjectPropertyTargetType targetType,
                 java.lang.String propertyName,
                 java.lang.Object value)
          throws NotFoundException

For a target object, sets a value.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the targetType of the object of interest.

propertyName - The property name

value - The property value

Returns:

true if the value was set

Throws:

NotFoundException - If the target object or property is not found

deleteValue

void deleteValue(XInfo targetXinfo,
                 ObjectPropertyTargetType targetType,
                 java.lang.String propertyName)
          throws NotFoundException

For a target object, removes the value.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the targetType of the object of interest.

propertyName - The property name

Throws:

NotFoundException - If the target object or property is not found

getValue

ObjectProperty getValue(XInfo targetXinfo,
                        java.lang.String propertyName,
                        ObjectPropertyTargetType targetType,
                        java.util.List<XInfo> groupContext)
                 throws NotFoundException

Get the ObjectProperty for a particular target with the given propertyName. GroupContext is only necessary if the property your looking for uses a ObjectPropertyHierarchyType that contains groups and you want to use a list of groups that may contain a property override

Parameters:

targetXinfo - The external reference information for the object of interest

propertyName - The property name

targetType - the ObjectPropertyTargetType of the object of interest

groupContext - the list of groups to consider for group hierarchy.

Returns:

The current ObjectProperty

Throws:

NotFoundException - If the target object or property is not found

See Also:

getValue(XInfo, String, ObjectPropertyTargetType)

getValue

ObjectProperty getValue(XInfo targetXinfo,
                        java.lang.String propertyName,
                        ObjectPropertyTargetType targetType)
                 throws NotFoundException

Get the ObjectProperty for a particular target with the given propertyName. This version is used when group context is not necessary. If you need to use group hierarchy for property overrides then use getValue(XInfo, String, ObjectPropertyTargetType, List)

Parameters:

targetXinfo - The external reference information for the object of interest

propertyName - The property name

targetType - the ObjectPropertyTargetType of the object of interest

Returns:

The current ObjectProperty

Throws:

NotFoundException - If the target object or property is not found

See Also:

getValue(XInfo, String, ObjectPropertyTargetType, List)

getValues

java.util.List<ObjectProperty> getValues(XInfo targetXinfo,
                                         ObjectPropertyTargetType targetType,
                                         java.util.List<XInfo> groupContext)

Get the ObjectProperties for a particular target. GroupContext is only necessary if the properties your looking for use a ObjectPropertyHierarchyType that contains groups and you want to use a list of groups that may contain property overrides.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

groupContext - the list of groups to consider for group hierarchy.

Returns:

The list of ObjectProperties for the given target

Throws:

NotFoundException - If the target object is not found

See Also:

getValues(XInfo, ObjectPropertyTargetType)

getValues

java.util.List<ObjectProperty> getValues(XInfo targetXinfo,
                                         ObjectPropertyTargetType targetType)

Works like getValues(XInfo, ObjectPropertyTargetType, List) except there is no group context.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

Returns:

The list of ObjectProperties for the given target

Throws:

NotFoundException - If the target object is not found

See Also:

getValues(XInfo, ObjectPropertyTargetType, List)

getValuesByTarget

java.util.List<ObjectProperty> getValuesByTarget(XInfo targetXinfo,
                                                 ObjectPropertyTargetType targetType,
                                                 java.util.List<XInfo> groupContext,
                                                 java.util.List<ObjectPropertyTargetType> definitionTargets)
                                          throws NotFoundException

Get the ObjectProperties for a particular target where each property applies to one of the given definitionTargets. GroupContext is only necessary if the properties your looking for use a ObjectPropertyHierarchyType that contains groups and you want to use a list of groups that may contain property overrides.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

groupContext - the list of groups to consider for group hierarchy.

definitionTargets - the list of ObjectPropertyTargetType that each returned property will apply to

Returns:

The list of ObjectProperties

Throws:

NotFoundException - If the target object is not found

See Also:

getValuesByTarget(XInfo, ObjectPropertyTargetType, List), getValuesByTarget(XInfo, ObjectPropertyTargetType, List, ObjectPropertyTargetType), getValuesByTarget(XInfo, ObjectPropertyTargetType, ObjectPropertyTargetType)

getValuesByTarget

java.util.List<ObjectProperty> getValuesByTarget(XInfo targetXinfo,
                                                 ObjectPropertyTargetType targetType,
                                                 java.util.List<ObjectPropertyTargetType> definitionTargets)
                                          throws NotFoundException

Works like getValuesByTarget(XInfo, ObjectPropertyTargetType, List, List) except there is no groupContext.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

definitionTargets - the list of ObjectPropertyTargetType that each returned property will apply to

Returns:

The list of ObjectProperties

Throws:

NotFoundException - If the target object is not found

See Also:

getValuesByTarget(XInfo, ObjectPropertyTargetType, List, List), getValuesByTarget(XInfo, ObjectPropertyTargetType, List, ObjectPropertyTargetType), getValuesByTarget(XInfo, ObjectPropertyTargetType, ObjectPropertyTargetType)

getValuesByTarget

java.util.List<ObjectProperty> getValuesByTarget(XInfo targetXinfo,
                                                 ObjectPropertyTargetType targetType,
                                                 java.util.List<XInfo> groupContext,
                                                 ObjectPropertyTargetType definitionTarget)
                                          throws NotFoundException

Works like getValuesByTarget(XInfo, ObjectPropertyTargetType, List, List) with a single definitionTarget.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

groupContext - the list of groups to consider for group hierarchy.

definitionTarget - the ObjectPropertyTargetType that each returned property will apply to

Returns:

The list of ObjectProperties

Throws:

NotFoundException - If the target object is not found

See Also:

getValuesByTarget(XInfo, ObjectPropertyTargetType, List, List), getValuesByTarget(XInfo, ObjectPropertyTargetType, List), getValuesByTarget(XInfo, ObjectPropertyTargetType, ObjectPropertyTargetType)

getValuesByTarget

java.util.List<ObjectProperty> getValuesByTarget(XInfo targetXinfo,
                                                 ObjectPropertyTargetType targetType,
                                                 ObjectPropertyTargetType definitionTarget)
                                          throws NotFoundException

Works like getValuesByTarget(XInfo, ObjectPropertyTargetType, List) with a single definitionTarget. This method also contains no groupContext

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

definitionTarget - the ObjectPropertyTargetType that each returned property will apply to

Returns:

The list of ObjectProperties

Throws:

NotFoundException - If the target object is not found

See Also:

getValuesByTarget(XInfo, ObjectPropertyTargetType, List, List), getValuesByTarget(XInfo, ObjectPropertyTargetType, List), getValuesByTarget(XInfo, ObjectPropertyTargetType, List, ObjectPropertyTargetType)

getValuesByName

java.util.List<ObjectProperty> getValuesByName(XInfo targetXinfo,
                                               ObjectPropertyTargetType targetType,
                                               java.util.List<XInfo> groupContext,
                                               java.util.List<java.lang.String> propertyNames)
                                        throws NotFoundException

Get the ObjectProperties for the given target with the given propertyNames. GroupContext is only necessary if the properties your looking for use a ObjectPropertyHierarchyType that contains groups and you want to use a list of groups that may contain property overrides.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

groupContext - the list of groups to consider for group hierarchy.

propertyNames - the list of property names.

Returns:

the list of ObjectProperties

Throws:

NotFoundException - If the target object is not found

See Also:

getValuesByName(XInfo, ObjectPropertyTargetType, List)

getValuesByName

java.util.List<ObjectProperty> getValuesByName(XInfo targetXinfo,
                                               ObjectPropertyTargetType targetType,
                                               java.util.List<java.lang.String> propertyNames)
                                        throws NotFoundException

Works like getValuesByName(XInfo, ObjectPropertyTargetType, List, List) except there is no group context.

Parameters:

targetXinfo - The external reference information for the object of interest

targetType - the ObjectPropertyTargetType of the object of interest

propertyNames - the list of property names.

Returns:

the list of ObjectProperties

Throws:

NotFoundException - If the target object is not found

See Also:

getValuesByName(XInfo, ObjectPropertyTargetType, List, List)

disableProperty

void disableProperty(java.lang.String propertyName)
              throws NotFoundException

Set the is_Active property of a given property to false. The property will not be available for use.

Parameters:

propertyName - The name of the property of interest

Throws:

NotFoundException - If the property is not found

enableProperty

void enableProperty(java.lang.String propertyName)
             throws NotFoundException

Enable a property.

Parameters:

propertyName - The name of the property of interest

Throws:

NotFoundException - IF the property is not found.

createOrUpdatePropertyExposure

void createOrUpdatePropertyExposure(java.lang.String propertyName,
                                    boolean exposed,
                                    boolean editable,
                                    java.lang.String category)

Create or update the property exposure settings

Parameters:

propertyName - the property name to relate these settings

exposed - whether or not the property is exposed

editable - whether or not the property is editable

category - The category to give the property (leave null if not needed)

getDefaultValues

java.util.List<ObjectProperty> getDefaultValues(java.util.List<java.lang.String> propertyNames)

Return the default values for the requested properties

Parameters:

propertyNames - the requested property names

Returns:

The default value for the requested properties

getDefaultValue

ObjectProperty getDefaultValue(java.lang.String propertyName)

Return the default value for the requested property

Parameters:

propertyName - the requested property name

Returns:

the default value for the requested property

getPropertiesWithNoValue

java.util.List<ObjectProperty> getPropertiesWithNoValue()

Return the object properties for properties that have no value. These properties are only able to be written into the assignment snapshot. Other than that they have no value or use.

Returns:

the list of properties with no value.