curam.util.workflow.intf

Interface BusinessObjectAssociationAdmin

All Known Implementing Classes:

curam.util.workflow.base.BusinessObjectAssociationAdmin, BusinessObjectAssociationAdmin

@AccessLevel(value=EXTERNAL)
public interface BusinessObjectAssociationAdmin

The BizObjAssociation entity stores details of associations between tasks and other rows on other database tables. This API provides functions to manipulate the data on the BizObjAssociation entity and its functions should be used rather than direct access to the functions present on the actual entity.

Method Summary

Modifier and Type	Method and Description
long	countOpenTasksByBizObjectTypeAndID(long bizObjectID, java.lang.String bizObjectType, java.lang.String closedTaskStatusToIgnore, java.lang.String completedTaskStatusToIgnore) Returns a count of the tasks associated with the specified business object type and business object identifier.
long	create(java.lang.String bizObjectType, long taskID, long bizObjectID) Creates a business object association.
void	modify(long bizObjAssocID, java.lang.String bizObjectType, long taskID, long bizObjectID) Modifies the details of a business object association.
void	modifyBusinessObjectID(long bizObjAssocID, long bizObjectID) Modifies the business object identifier of a business object association instance.
BizObjectAssociationDetails	read(long bizObjAssocID) Returns the details of an business object association based on the specified business object association identifier.
void	remove(long bizObjAssocID) Removes a business object association.
BizObjAssocSearchDetailsList	searchByBizObjectTypeAndID(long bizObjectID, java.lang.String bizObjectType) Returns the details of any tasks associated with a business object.
BizObjectAssociationDetailsList	searchByTaskID(long taskID) Returns the details of all the business object associations for a specified task.

Method Detail

read

BizObjectAssociationDetails read(long bizObjAssocID)
                          throws curam.util.exception.AppException,
                                 curam.util.exception.InformationalException

Returns the details of an business object association based on the specified business object association identifier.

Parameters:

bizObjAssocID - The identifier of the business object association.

Returns:

The business object association details.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

create

long create(java.lang.String bizObjectType,
            long taskID,
            long bizObjectID)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Creates a business object association. A unique key for the new record is generated by this function. A business object association identifier, a business object type and a task identifier must be specified.

Parameters:

bizObjectType - The business object type.

taskID - The identifier of the task to associate with a business object.

bizObjectID - A particular instance of the specified business object type.

Returns:

The identifier of the newly created business object association.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

remove

void remove(long bizObjAssocID)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Removes a business object association.

Parameters:

bizObjAssocID - The identifier of the business object association which will be removed.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modify

void modify(long bizObjAssocID,
            java.lang.String bizObjectType,
            long taskID,
            long bizObjectID)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Modifies the details of a business object association.

Parameters:

bizObjAssocID - The identifier of the business object association.

bizObjectType - The business object type.

taskID - The identifier of the task to associate with a business object.

bizObjectID - A particular instance of the specified business object type.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

countOpenTasksByBizObjectTypeAndID

long countOpenTasksByBizObjectTypeAndID(long bizObjectID,
                                        java.lang.String bizObjectType,
                                        java.lang.String closedTaskStatusToIgnore,
                                        java.lang.String completedTaskStatusToIgnore)
                                 throws curam.util.exception.AppException,
                                        curam.util.exception.InformationalException

Returns a count of the tasks associated with the specified business object type and business object identifier. Tasks with a status of Completed or Closed will be excluded from the results returned.

Parameters:

bizObjectID - The unique identifier of the business object type.

bizObjectType - The type of the business object.

closedTaskStatusToIgnore - A task status of closed that will be ignored.

completedTaskStatusToIgnore - A task status of completed that will be ignored.

Returns:

The number of tasks associated with the specified business object type and business object identifier.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

modifyBusinessObjectID

void modifyBusinessObjectID(long bizObjAssocID,
                            long bizObjectID)
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Modifies the business object identifier of a business object association instance.

Parameters:

bizObjAssocID - The identifier of the business object association.

bizObjectID - A particular instance of the specified business object type.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

searchByBizObjectTypeAndID

BizObjAssocSearchDetailsList searchByBizObjectTypeAndID(long bizObjectID,
                                                        java.lang.String bizObjectType)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Returns the details of any tasks associated with a business object. The business object required is identified by its type and associated identifier.

Parameters:

bizObjectID - A particular instance of the specified business object type.

bizObjectType - The business object type.

Returns:

The details of the tasks associated with a specified business object.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.

searchByTaskID

BizObjectAssociationDetailsList searchByTaskID(long taskID)
                                        throws curam.util.exception.AppException,
                                               curam.util.exception.InformationalException

Returns the details of all the business object associations for a specified task.

Parameters:

taskID - The unique identifier of a task.

Returns:

The details of the business object associations for a specified task.

Throws:

curam.util.exception.AppException - Exceptions that may occur when invoking this function.

curam.util.exception.InformationalException - Generic Exception Signature.