KimTypeService

• getWorkflowDocumentTypeName
• getWorkflowRoutingAttributes
• getAttributeDefinitions
• validateAttributes
• validateAttributesAgainstExisting
• validateUniqueAttributes
• validateUnmodifiableAttributes

• KimAttributeField
• RemotableAttributeError

Method	getWorkflowDocumentTypeName
Description	Gets the name of a workflow document type that should be passed to kew when resolving responsibilities for routing. This name will be passed as a qualifier with the "documentTypeName" key. return null to indicate that there is no custom workflow document needed for this type.
Parameters	None	None	No Parameters
Return	String		the doc type name or null.
Errors	NONE		No Errors

Back to Operations

Method	getWorkflowRoutingAttributes
Description	Gets an unmodifiable list of attribute names identifying the attribute qualifiers that are provided to the KIM responsibility service when resolving responsibility-based routing at the node with the given name. Returns an empty list, indicating that no attributes from this type should be passed to workflow.
Parameters	String	nodeName	the name of the node to retrieve attribute names for. Cannot be null or blank.
Return	StringList		an unmodifiable list should not return null.
Errors	RiceIllegalArgumentException		???

Back to Operations

Method	getAttributeDefinitions
Description	Gets a List of {@link KimAttributeField} for a kim type id. The order of the attribute fields in the list can be used as a hint to a ui framework consuming these attributes as to how to organize these fields.
Parameters	String	kimTypeId	the kimTypeId to retrieve fields for. Cannot be null or blank.
Return	KimAttributeFieldList		an immutable list of KimAttributeField. Will not return null.
Errors	RiceIllegalArgumentException		???

Back to Operations

Method	validateAttributes
Description	This method validates the passed in attributes for a kimTypeId generating a List of {@link RemotableAttributeError}. The order of the attribute errors in the list can be used as a hint to a ui framework consuming these errors as to how to organize these errors.
Parameters	String	kimTypeId	the kimTypeId that is associated with the attributes. Cannot be null or blank.
	Map	attributes	the kim type attributes to validate. Cannot be null.
Return	RemotableAttributeErrorList		an immutable list of RemotableAttributeError. Will not return null.
Errors	RiceIllegalArgumentException		???

Back to Operations

Method	validateAttributesAgainstExisting
Description	This method validates the passed in attributes for a kimTypeId generating a List of {@link RemotableAttributeError}. This method used the oldAttributes to aid in validation. This is useful for validating "new" or "updated" attributes. The order of the attribute errors in the list can be used as a hint to a ui framework consuming these errors as to how to organize these errors.
Parameters	String	kimTypeId	the kimTypeId that is associated with the attributes. Cannot be null or blank.
	Map	newAttributes	the kim type attributes to validate. Cannot be null.
	Map	oldAttributes	the old kim type attributes to use for validation. Cannot be null.
Return	RemotableAttributeErrorList		an immutable list of RemotableAttributeError. Will not return null.
Errors	RiceIllegalArgumentException		???

Back to Operations

Method	validateUniqueAttributes
Description	This method validates the passed in attributes for a kimTypeId generating a List of {@link RemotableAttributeError}. This method used the oldAttributes to aid in validation. This method specifically determines if attributes should be unique and verifying them against other attributes that have been set to determine uniqueness The order of the attribute errors in the list can be used as a hint to a ui framework consuming these errors as to how to organize these errors.
Parameters	String	kimTypeId	the kimTypeId that is associated with the attributes. Cannot be null or blank.
	Map	newAttributes	the kim type attributes to validate. Cannot be null.
	Map	oldAttributes	the old kim type attributes to use for validation. Cannot be null.
Return	RemotableAttributeErrorList		an immutable list of RemotableAttributeError. Will not return null.
Errors	RiceIllegalArgumentException		???

Back to Operations

Method	validateUnmodifiableAttributes
Description	This method validates the passed in attributes for a kimTypeId generating a List of {@link RemotableAttributeError}. This method used the oldAttributes to aid in validation. This method specifically validates that the new attribute values have not been changed if they are unmodifiable. The order of the attribute errors in the list can be used as a hint to a ui framework consuming these errors as to how to organize these errors.
Parameters	String	kimTypeId	the kimTypeId that is associated with the attributes. Cannot be null or blank.
	Map	originalAttributes	the old kim type attributes to use for validation. Cannot be null.
	Map	newAttributes	the kim type attributes to validate. Cannot be null.
Return	RemotableAttributeErrorList		an immutable list of RemotableAttributeError. Will not return null.
Errors	RiceIllegalArgumentException		???

Back to Operations