|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWTableDefinition | +--filenet.vw.api.VWRosterDefinition
Use the VWRosterDefinition class to retrieve and administer roster definition information. The methods of this class operate in conjunction with VWSystemConfiguration class methods as follows:
VWSystemConfiguration
, Serialized FormField Summary | |
static int |
CONFIG_TYPE_LOG
Integer value of 3. This field value indicates a log configuration type. |
static int |
CONFIG_TYPE_QUEUE
Integer value of 2. This field value indicates a queue configuration type. |
static int |
CONFIG_TYPE_ROSTER
Integer value of 1. This field value indicates a roster configuration type. |
static int |
LVALUE
Integer value of 0: this constant can be used to subscript into the pre or post assignment arrays. |
static int |
RVALUE
Integer value of 1: this constant can be used to subscript into the pre or post assignment arrays. |
Method Summary | |
java.lang.Object |
clone()
Creates a clone of this VWRosterDefinition object. |
VWExposedFieldDefinition |
createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field on the roster, based on the supplied field name and type. |
VWIndexDefinition |
createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for the roster. |
void |
deleteFieldDefinition(java.lang.String theName)
Deletes an exposed field from the roster. |
void |
deleteIndexDefinition(java.lang.String theName)
Deletes an index from this roster. |
java.lang.String[] |
getCreateSecurity()
Lists users and/or groups who have create access to the roster. |
java.lang.String |
getDescription()
Provides the description for this roster definition. |
VWExposedFieldDefinition[] |
getFields()
Lists exposed field definitions for this roster definition. |
VWIndexDefinition[] |
getIndexes()
Lists index definitions for this roster definition. |
static java.lang.String |
getLocalizedString(int theConfigType)
Gets a localized string representation of the config type. |
java.lang.String |
getName()
Gets the name of the roster. |
java.lang.String[] |
getReadSecurity()
Lists the users and/or groups who currently have read-only access to the roster. |
int |
getServerId()
Gets the home server ID of this roster definition. |
java.lang.String[] |
getWriteSecurity()
Lists users and/or groups who have write access to the roster. |
boolean |
hasFieldName(java.lang.String fieldName)
Determine whether a specified log, queue, or roster field exists. |
static boolean |
isValid(int theConfigType)
Validates the config type a valid type. |
static VWExposedFieldDefinition[] |
optionalSystemFields()
Returns workflow system exposed fields that are marked as optional. |
static VWExposedFieldDefinition[] |
optionalSystemFields(int theType)
Get optional exposed workflow system fields for one among: roster, queue, or log. |
void |
setCreateSecurity(java.lang.String[] theNames)
Sets create access for the roster. |
void |
setDescription(java.lang.String theDescription)
Sets the description for this roster definition. |
void |
setReadSecurity(java.lang.String[] theNames)
Sets read-only access for the roster. |
void |
setServerId(int theNewServerId)
Sets the home server ID of the roster. |
void |
setWriteSecurity(java.lang.String[] theNames)
Sets write access for the roster. |
java.lang.String |
toString()
Returns the string version of the roster definition. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int LVALUE
public static final int RVALUE
public static final int CONFIG_TYPE_ROSTER
public static final int CONFIG_TYPE_QUEUE
public static final int CONFIG_TYPE_LOG
Method Detail |
public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName, int theType, int theLength) throws VWException
createFieldDefinition
in interface IVWTableDefinition
createFieldDefinition
in class filenet.vw.api.VWTableDefinition
theName
- The name of the field to
expose.
theType
- An integer value indicating the data type
associated with the exposed field. Note that arrays, for any
of the data types, are not allowed. Valid values are as follows:
theLength
- An integer value specifying the length
(number of bytes) of data stored if the data field is a string. If
the field type is other than string, specify the 0 (zero).VWException
- public void deleteFieldDefinition(java.lang.String theName) throws VWException
deleteFieldDefinition
in interface IVWTableDefinition
deleteFieldDefinition
in class filenet.vw.api.VWTableDefinition
theName
- The name of the exposed
field to delete from the roster.VWException
- Thrown if the
field specified in the theName parameter is not found.public VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) throws VWException
createIndexDefinition
in interface IVWTableDefinition
theName
- The name of the new index
field.theFieldNames
- A string array containing the system
fields and/or user-defined exposed fields.VWException
- Thrown if the system finds an error
in the name or if the fields are undefined.public void deleteIndexDefinition(java.lang.String theName) throws VWException
deleteIndexDefinition
in interface IVWTableDefinition
deleteIndexDefinition
in class filenet.vw.api.VWTableDefinition
theName
- The name of the index to be
deleted from the roster.VWException
- Thrown if the
system does not find the index name.public VWExposedFieldDefinition[] getFields() throws VWException
getFields
in interface IVWTableDefinition
getFields
in class filenet.vw.api.VWTableDefinition
VWException
- public VWIndexDefinition[] getIndexes() throws VWException
getIndexes
in interface IVWTableDefinition
getIndexes
in class filenet.vw.api.VWTableDefinition
VWException
- public java.lang.String getName()
getName
in interface IVWTableDefinition
getName
in class filenet.vw.api.VWTableDefinition
public int getServerId()
getServerId
in class filenet.vw.api.VWTableDefinition
public void setServerId(int theNewServerId) throws VWException
setServerId
in class filenet.vw.api.VWTableDefinition
theNewServerId
- An integer value to be used as the new
home server ID.VWException
- Thrown if it cannot
set the home server ID of the roster.VWSystemConfiguration.getServerIDs()
public java.lang.String[] getReadSecurity()
getReadSecurity
in class filenet.vw.api.VWTableDefinition
public void setReadSecurity(java.lang.String[] theNames) throws VWException
theNames
- A list of names and/or groups who are to have
read-only access to the roster.VWException
- public java.lang.String[] getWriteSecurity()
getWriteSecurity
in class filenet.vw.api.VWTableDefinition
public void setWriteSecurity(java.lang.String[] theNames) throws VWException
theNames
- A list of names and/or groups who are to have
write access.VWException
- public java.lang.String[] getCreateSecurity()
public void setCreateSecurity(java.lang.String[] theNames) throws VWException
theNames
- A list of user names and/or groups who will be
granted create access on the roster.VWException
- Thrown if it cannot set create access
for the roster.public java.lang.String getDescription()
getDescription
in interface IVWTableDefinition
getDescription
in class filenet.vw.api.VWTableDefinition
public void setDescription(java.lang.String theDescription)
setDescription
in interface IVWTableDefinition
setDescription
in class filenet.vw.api.VWTableDefinition
theDescription
- The description for
this roster definitionpublic java.lang.String toString()
toString
in interface IVWTableDefinition
toString
in class filenet.vw.api.VWTableDefinition
public static VWExposedFieldDefinition[] optionalSystemFields() throws VWException
public java.lang.Object clone()
VWRosterDefinition
object.clone
in class filenet.vw.api.VWTableDefinition
public static VWExposedFieldDefinition[] optionalSystemFields(int theType) throws VWException
theType
- Type of collection on which the
optional system field is exposed, as follows:
public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- Name of the log, queue, or roster fieldVWException
- Thrown if the field name parameter is nullpublic static java.lang.String getLocalizedString(int theConfigType) throws VWException
theConfigType
- An integer value associated the config type.VWException
- Thrown if the
config type value specified in the theConfigType parameter is invalid.public static boolean isValid(int theConfigType)
theConfigType
- The integer value associated with the
config type value to be validated.
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |