|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkBasketDefinition
Accesses the properties of a work basket and allows for setting values. A work basket definition is used to create or update a persistently stored work basket.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
DEFAULT_CONTAINER_JNDI_NAME_OF_STAFF_PLUGIN_PROVIDER
States the default value for getJNDINameOfStaffPluginProvider. |
static int |
SUBSTITUTION_POLICY_NO_SUBSTITUTION
States that no substitution should take place. |
static int |
SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT
States that only present users should act for absent users. |
static int |
SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT
States that substitutes should act for absent users. |
static int |
TYPE_CLEARANCE
States that tasks contained in this work basket cannot be processed as they are, but require special care. |
static int |
TYPE_GROUP
States that tasks contained in this work basket are to be processed by a certain group of people, for example, teams or departments. |
static int |
TYPE_INDIVIDUAL
States that tasks contained in this work basket are assigned to a specific person. |
static int |
TYPE_TOPIC
States that tasks contained in this work basket belong to a certain theme or topic. |
Method Summary | |
---|---|
java.lang.String |
getCustomText1()
Returns the custom text specified as custom text one. |
java.lang.String |
getCustomText2()
Returns the custom text specified as custom text two. |
java.lang.String |
getCustomText3()
Returns the custom text specified as custom text three. |
java.lang.String |
getCustomText4()
Returns the custom text specified as custom text four. |
java.lang.String |
getCustomText5()
Returns the custom text specified as custom text five. |
java.lang.String |
getCustomText6()
Returns the custom text specified as custom text six. |
java.lang.String |
getCustomText7()
Returns the custom text specified as custom text seven. |
java.lang.String |
getCustomText8()
Returns the custom text specified as custom text eight. |
java.lang.String |
getDefaultQueryTable()
Returns the name of the default query table associated to the work basket. |
java.lang.String |
getDescription(java.util.Locale arg0)
Returns the description in the specified locale. |
java.lang.String |
getDisplayName(java.util.Locale arg0)
Returns the display name in the specified locale. |
java.util.List |
getDistributionTargets()
Returns a list of object IDs ( WBIDs ) of work baskets that are distribution targets of this work basket. |
java.lang.String |
getJNDINameOfStaffPluginProvider()
Returns the JNDI name of a user-defined people directory configuration. |
java.util.List |
getLocalesOfDescriptions()
Returns the locales of all descriptions. |
java.util.List |
getLocalesOfDisplayNames()
Returns the locales of all display names. |
java.lang.String |
getName()
Returns the name of the work basket. |
java.lang.String |
getOwner()
Returns the owner of the work basket. |
PeopleAssignment |
getPeopleAssignment(int arg0)
Returns the staff assignments for the passed role. |
java.util.List |
getReasonsOfPeopleAssignment()
Returns a list of Integer objects that state the assignment reasons. |
int |
getSubstitutionPolicy()
Returns the substitution policy that takes place when people assignments are performed. |
int |
getType()
Returns the type of the work basket. |
boolean |
isCustomText1Updateable()
Signals whether the custom text 1 property can be changed for the kind and current state of the object. |
boolean |
isCustomText2Updateable()
Signals whether the custom text 2 property can be changed for the kind and current state of the object. |
boolean |
isCustomText3Updateable()
Signals whether the custom text 3 property can be changed for the kind and current state of the object. |
boolean |
isCustomText4Updateable()
Signals whether the custom text 4 property can be changed for the kind and current state of the object. |
boolean |
isCustomText5Updateable()
Signals whether the custom text 5 property can be changed for the kind and current state of the object. |
boolean |
isCustomText6Updateable()
Signals whether the custom text 6 property can be changed for the kind and current state of the object. |
boolean |
isCustomText7Updateable()
Signals whether the custom text 7 property can be changed for the kind and current state of the object. |
boolean |
isCustomText8Updateable()
Signals whether the custom text 8 property can be changed for the kind and current state of the object. |
boolean |
isDefaultQueryTableUpdateable()
Signals whether the default query table property can be changed for the kind and current state of the object. |
boolean |
isDescriptionUpdateable()
Signals whether the description property can be changed for the kind and current state of the object. |
boolean |
isDisplayNameUpdateable()
Signals whether the display name property can be changed for the kind and current state of the object. |
boolean |
isDistributionTargetsUpdateable()
Signals whether the source w b ID property can be changed for the kind and current state of the object. |
boolean |
isJNDINameOfStaffPluginProviderUpdateable()
Signals whether the jndi name staff provider property can be changed for the kind and current state of the object. |
boolean |
isOwnerUpdateable()
Signals whether the owner property can be changed for the kind and current state of the object. |
boolean |
isPeopleAssignmentUpdateable()
Signals whether the custom text 8 property can be changed for the kind and current state of the object. |
boolean |
isSubstitutionPolicyUpdateable()
Signals whether the substitution policy property can be changed for the kind and current state of the object. |
boolean |
isTypeUpdateable()
Signals whether the type property can be changed for the kind and current state of the object. |
void |
setCustomText1(java.lang.String customText1)
Sets the custom text specified as custom text one. |
void |
setCustomText2(java.lang.String customText2)
Sets the custom text specified as custom text two. |
void |
setCustomText3(java.lang.String customText3)
Sets the custom text specified as custom text three. |
void |
setCustomText4(java.lang.String customText4)
Sets the custom text specified as custom text four. |
void |
setCustomText5(java.lang.String customText5)
Sets the custom text specified as custom text five. |
void |
setCustomText6(java.lang.String customText6)
Sets the custom text specified as custom text six. |
void |
setCustomText7(java.lang.String customText7)
Sets the custom text specified as custom text seven. |
void |
setCustomText8(java.lang.String customText8)
Sets the custom text specified as custom text eight. |
void |
setDefaultQueryTable(java.lang.String defaultQueryTable)
Sets the default query table associated to the business category. |
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the description in the specified locale. |
void |
setDisplayName(java.lang.String displayName,
java.util.Locale locale)
Sets the display name in the specified locale. |
void |
setDistributionTargets(java.util.List wbids)
Sets the distribution targets associated to the work basket. |
void |
setJNDINameOfStaffPluginProvider(java.lang.String jndiNameStaffProvider)
Sets the JNDI name of a user-defined people directory configuration. |
void |
setOwner(java.lang.String owner)
Sets the owner of the work basket. |
void |
setPeopleAssignment(int assignmentReason,
PeopleAssignment people)
Sets the assignment reason for the specified people. |
void |
setSubstitutionPolicy(int substitutionPolicy)
Sets the substitution policy that takes place when people assignments are performed. |
void |
setType(int type)
Sets the type of the work basket. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final java.lang.String DEFAULT_CONTAINER_JNDI_NAME_OF_STAFF_PLUGIN_PROVIDER
static final int TYPE_CLEARANCE
static final int TYPE_TOPIC
static final int TYPE_GROUP
static final int TYPE_INDIVIDUAL
static final int SUBSTITUTION_POLICY_NO_SUBSTITUTION
static final int SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT
static final int SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT
Method Detail |
---|
java.lang.String getName()
int getType()
Possible types are TYPE_GROUP, TYPE_TOPIC, TYPE_INDIVIDUAL, or TYPE_CLEARANCE.
java.lang.String getDisplayName(java.util.Locale arg0)
If no locale is specified, the display name in the default locale is returned or any available display name, if there is only a single display name.
arg0
- The locale for which the display name is to be provided.java.util.List getLocalesOfDisplayNames()
java.lang.String getDescription(java.util.Locale arg0)
If no locale is specified, the description in the default locale is returned or any available description, if there is only a single description.
arg0
- The locale for which the description is to be provided.java.util.List getLocalesOfDescriptions()
java.lang.String getOwner()
java.util.List getDistributionTargets()
WBIDs
) of work baskets that are distribution targets of this work basket.
Note, if you modify an existing list of distribution targets, then you must call
setDistributionTargets
before calling updateWorkBasket. The list returned by this method
is a copy of the list contained in the WorkBasketDefinition.
For example,
.
WorkBasketDefinition workBasketDefinition = service.getWorkBasketDefinition("MyWorkBasket");
List lst = workBasketDefinition.getDistributionTargets();
lst.add(wbid);
workBasketDefinition.setDistributionTargets(lst);
service.updateWorkBasket(workBasketDefinition);
java.lang.String getDefaultQueryTable()
PeopleAssignment getPeopleAssignment(int arg0)
WorkItem.REASON_READER
.
arg0
- The role for which the people assignment is to be provided.java.util.List getReasonsOfPeopleAssignment()
java.lang.String getJNDINameOfStaffPluginProvider()
int getSubstitutionPolicy()
Possible substitution policies are SUBSTITUTION_POLICY_NO_SUBSTITUTION, SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT, SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT.
java.lang.String getCustomText1()
java.lang.String getCustomText2()
java.lang.String getCustomText3()
java.lang.String getCustomText4()
java.lang.String getCustomText5()
java.lang.String getCustomText6()
java.lang.String getCustomText7()
java.lang.String getCustomText8()
void setType(int type)
Possible types are TYPE_GROUP, TYPE_TOPIC, TYPE_INDIVIDUAL, or TYPE_CLEARANCE.
type
- The type that is to be set.boolean isTypeUpdateable()
void setDisplayName(java.lang.String displayName, java.util.Locale locale)
displayName
- The new value of the display name.locale
- The locale for which the display name is set.
Note that there is a special locale called default
which can be used to set
the display name in the default language. The default language is specified
by passing null or new Locale("default")
.boolean isDisplayNameUpdateable()
void setDescription(java.lang.String description, java.util.Locale locale)
description
- The new value of the description.locale
- The locale for which the description is set.
Note that there is a special locale called default
which can be used to set
the description in the default language. The default language is specified
by passing null or new Locale("default")
.boolean isDescriptionUpdateable()
void setOwner(java.lang.String owner)
owner
- The owner who is to be set.boolean isOwnerUpdateable()
void setDistributionTargets(java.util.List wbids)
getDistributionTargets
is a copy of the list contained in the WorkBasketDefinition.
For example,
.
WorkBasketDefinition workBasketDefinition = service.getWorkBasketDefinition("MyWorkBasket");
List lst = workBasketDefinition.getDistributionTargets();
lst.add(wbid);
workBasketDefinition.setDistributionTargets(lst);
service.updateWorkBasket(workBasketDefinition);
boolean isDistributionTargetsUpdateable()
void setDefaultQueryTable(java.lang.String defaultQueryTable)
defaultQueryTable
- The default query table associated to the business category.boolean isDefaultQueryTableUpdateable()
void setJNDINameOfStaffPluginProvider(java.lang.String jndiNameStaffProvider)
jndiNameStaffProvider
- The JNDI name of the user-defined people directory configuration.boolean isJNDINameOfStaffPluginProviderUpdateable()
void setSubstitutionPolicy(int substitutionPolicy)
Possible substitution policies are SUBSTITUTION_POLICY_NO_SUBSTITUTION, SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT, SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT.
substitutionPolicy
- The substitution policy that should take place.boolean isSubstitutionPolicyUpdateable()
void setCustomText1(java.lang.String customText1)
customText1
- The custom text.boolean isCustomText1Updateable()
void setCustomText2(java.lang.String customText2)
customText2
- The custom text.boolean isCustomText2Updateable()
void setCustomText3(java.lang.String customText3)
customText3
- The custom text.boolean isCustomText3Updateable()
void setCustomText4(java.lang.String customText4)
customText4
- The custom text.boolean isCustomText4Updateable()
void setCustomText5(java.lang.String customText5)
customText5
- The custom text.boolean isCustomText5Updateable()
void setCustomText6(java.lang.String customText6)
customText6
- The custom text.boolean isCustomText6Updateable()
void setCustomText7(java.lang.String customText7)
customText7
- The custom text.boolean isCustomText7Updateable()
void setCustomText8(java.lang.String customText8)
customText8
- The custom text.boolean isCustomText8Updateable()
void setPeopleAssignment(int assignmentReason, PeopleAssignment people)
WorkItem.REASON_APPENDER
.
WorkItem.REASON_CUSTOMROLE_1
.
WorkItem.REASON_CUSTOMROLE_2
.
WorkItem.REASON_CUSTOMROLE_3
.
WorkItem.REASON_CUSTOMROLE_4
.
WorkItem.REASON_CUSTOMROLE_5
.
WorkItem.REASON_CUSTOMROLE_6
.
WorkItem.REASON_CUSTOMROLE_7
.
WorkItem.REASON_CUSTOMROLE_8
.
WorkItem.REASON_CUSTOMROLE_9
.
WorkItem.REASON_CUSTOMROLE_10
.
WorkItem.REASON_CUSTOMROLE_11
.
WorkItem.REASON_CUSTOMROLE_12
.
WorkItem.REASON_CUSTOMROLE_13
.
WorkItem.REASON_CUSTOMROLE_14
.
WorkItem.REASON_CUSTOMROLE_15
.
WorkItem.REASON_CUSTOMROLE_16
.
WorkItem.REASON_CUSTOMROLE_17
.
WorkItem.REASON_CUSTOMROLE_18
.
WorkItem.REASON_CUSTOMROLE_19
.
WorkItem.REASON_CUSTOMROLE_20
.
WorkItem.REASON_DISTRIBUTOR
.
WorkItem.REASON_INHERITANCE_ADMINISTRATOR
.
WorkItem.REASON_INHERITANCE_EDITOR
.
WorkItem.REASON_INHERITANCE_POTENTIAL_OWNER
.
WorkItem.REASON_INHERITANCE_READER
.
WorkItem.REASON_OPENER
.
WorkItem.REASON_READER
.
WorkItem.REASON_TRANSFER_INITIATOR
.
assignmentReason
- The assignment reason to be set.people
- The staff to be associated.boolean isPeopleAssignmentUpdateable()
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |