com.ibm.itim.apps.provisioning

Class ManualWorkOrder

java.lang.Object

com.ibm.itim.apps.provisioning.ManualWorkOrder

public class ManualWorkOrder
extends java.lang.Object

This class holds the work order details of a manual service or service connected in manual mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManualWorkOrder.OperationType The enum to represent the various types of valid operations.

Constructor Summary

Constructors

Constructor and Description
ManualWorkOrder(Participant participant, long escalationPeriod, Participant escalationParticipant, boolean defaultNotification, java.util.HashMap<ManualWorkOrder.OperationType,NotificationTemplate> operationNotification) Create a ManualWorkOrder object.

Method Summary

Modifier and Type	Method and Description
static ManualWorkOrder.OperationType[]	getAllOperations() Retrieves all the allowed operations as an array of type OperationType.
Participant	getEscalationParticipant() Retrieves the participant involved when the activity is escalated.
long	getEscalationPeriod() Retrieves the escalation period.
NotificationTemplate	getNotification(ManualWorkOrder.OperationType operation) Retrieves the notification template associated with the operation.
java.util.Map<ManualWorkOrder.OperationType,NotificationTemplate>	getOperationNotifications() Retrieves the map of operation notification template pairs.
Participant	getParticipant() Retrieves the participant associated with the work order.
boolean	isUseDefaultNotification() Specifies whether the default notification is being used.
void	setEscalationParticipant(Participant escalationParticipant) Sets the participant when the activity is escalated.
void	setEscalationPeriod(long escalationPeriod) Sets the escalation period.
void	setNotification(ManualWorkOrder.OperationType operation, NotificationTemplate notification) Sets the notification template for the specified operation.
void	setOperationNotification(java.util.HashMap<ManualWorkOrder.OperationType,NotificationTemplate> operationNotification) Sets the map of operation notifications.
void	setParticipant(Participant participant) Sets the participant to the specified value.
void	setUseDefaultNotification(boolean useDefaultNotification) Sets whether to use the default notification.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManualWorkOrder

public ManualWorkOrder(Participant participant,
                       long escalationPeriod,
                       Participant escalationParticipant,
                       boolean defaultNotification,
                       java.util.HashMap<ManualWorkOrder.OperationType,NotificationTemplate> operationNotification)
                throws com.ibm.itim.apps.ejb.service.InvalidOperationException

Create a ManualWorkOrder object.

Parameters:

participant - - Specifies the participant involved in the activity.

escalationPeriod - - Specifies the escalation period for the activity.

escalationParticipant - - Specifies ther participant involved when the activity escalates.

defaultNotification - - Specifies whether to use default notification.

operationNotification - - Specifies the map of notification operations.

Throws:

com.ibm.itim.apps.ejb.service.InvalidOperationException

Method Detail

getParticipant

public Participant getParticipant()

Retrieves the participant associated with the work order.

Returns:

Participant - The participant associated with the work order

See Also:

Participant

getEscalationPeriod

public long getEscalationPeriod()

Retrieves the escalation period.

Returns:

long - The escalation period

getEscalationParticipant

public Participant getEscalationParticipant()

Retrieves the participant involved when the activity is escalated.

Returns:

Participant - The participant when the activity is escalated.

See Also:

Participant

getNotification

public NotificationTemplate getNotification(ManualWorkOrder.OperationType operation)

Retrieves the notification template associated with the operation.

Parameters:

operation - OperationType associated with the NotificationTemplate

Returns:

NotificationTemplate - The notification template associated with the operation.

See Also:

NotificationTemplate

getOperationNotifications

public java.util.Map<ManualWorkOrder.OperationType,NotificationTemplate> getOperationNotifications()

Retrieves the map of operation notification template pairs.

Returns:

Map - The map of operation notification template pairs..

isUseDefaultNotification

public boolean isUseDefaultNotification()

Specifies whether the default notification is being used.

Returns:

boolean - Specifies whether the default notification is used.

setUseDefaultNotification

public void setUseDefaultNotification(boolean useDefaultNotification)

Sets whether to use the default notification.

Parameters:

useDefaultNotification - - boolean Specifies whether to use the default notification.

setParticipant

public void setParticipant(Participant participant)

Sets the participant to the specified value.

Parameters:

participant - - The participant value to set.

setEscalationPeriod

public void setEscalationPeriod(long escalationPeriod)

Sets the escalation period.

Parameters:

escalationPeriod - - Specifies the escalation period to set.

setEscalationParticipant

public void setEscalationParticipant(Participant escalationParticipant)

Sets the participant when the activity is escalated.

Parameters:

escalationParticipant - - Specifies the participant to be set when the activity is escalated.

setNotification

public void setNotification(ManualWorkOrder.OperationType operation,
                            NotificationTemplate notification)
                     throws com.ibm.itim.apps.ejb.service.InvalidOperationException

Sets the notification template for the specified operation.

Parameters:

operation - - Specifies the OperationType to set

notification - - Specifies the NotificationTemplate to set

Throws:

com.ibm.itim.apps.ejb.service.InvalidOperationException

setOperationNotification

public void setOperationNotification(java.util.HashMap<ManualWorkOrder.OperationType,NotificationTemplate> operationNotification)
                              throws com.ibm.itim.apps.ejb.service.InvalidOperationException

Sets the map of operation notifications.

Parameters:

operationNotification -

Throws:

com.ibm.itim.apps.ejb.service.InvalidOperationException

getAllOperations

public static ManualWorkOrder.OperationType[] getAllOperations()

Retrieves all the allowed operations as an array of type OperationType.

Returns:

Array of type OperationType of allowed operations.