com.remedy.arsys.api
Class AssignFieldInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.AssignFieldInfo

public class AssignFieldInfo

extends java.lang.Object

implements java.lang.Cloneable

The AssignFieldInfo class identifies a schema field value to assign in a Set Fields or Push Fields action. You can specify a value from any entry in any schema on a particular server.

Field Summary

static int	AR_FIELD AR_FIELD is a schema field value to compare in a relational operation.
static int	AR_STAT_HISTORY AR_STAT_HISTORY is a value from the Status-History core field to compare in a relational operation.

Constructor Summary

AssignFieldInfo()
constructor

AssignFieldInfo(java.lang.String server, java.lang.String schema, QualifierInfo qualifier, int tag, long fieldId, StatusHistoryValue statHistory, long noMatchOption, long multiMatchOption)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
long	getFieldId() Returns field ID value.
long	getMultiMatchOption() Returns option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields).
long	getNoMatchOption() Returns integer value indicating the action to take if no entries match the search criteria.
QualifierInfo	getQualifier() Returns the qualification that identifies the entries to retrieve (optional).
NameID	getSchema() Returns the name of the schema containing the field value to assign.
java.lang.String	getServer() Returns the name of the server where the schema is located.
StatusHistoryValue	getStatHistory() Returns Status History field value.
int	getTag() Returns integer value indicating the type of field value to retrieve with the following constant values:
void	setFieldId(long fieldId) Sets field ID value.
void	setMultiMatchOption(long multiMatchOption) Sets option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields).
void	setNoMatchOption(long noMatchOption) Sets integer value indicating the action to take if no entries match the search criteria.
void	setQualifier(QualifierInfo qualifier) Sets the qualification that identifies the entries to set (optional).
void	setSchema(NameID schema) Sets the name of the schema containing the field value to assign.
void	setServer(java.lang.String server) Sets the name of the server where the schema is located.
void	setStatHistory(StatusHistoryValue statHistory) Sets Status History field value.
void	setTag(int tag) Sets integer value indicating the type of field value to set with the following constant values:

Methods inherited from class java.lang.Object

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

Field Detail

AR_FIELD

public static final int AR_FIELD

AR_FIELD is a schema field value to compare in a relational operation.

AR_STAT_HISTORY

public static final int AR_STAT_HISTORY

AR_STAT_HISTORY is a value from the Status-History core field to compare in a relational operation.

Constructor Detail

AssignFieldInfo

public AssignFieldInfo()

constructor

AssignFieldInfo

public AssignFieldInfo(java.lang.String server,
                       java.lang.String schema,
                       QualifierInfo qualifier,
                       int tag,
                       long fieldId,
                       StatusHistoryValue statHistory,
                       long noMatchOption,
                       long multiMatchOption)

Method Detail

getFieldId

public long getFieldId()

Returns field ID value.

setFieldId

public void setFieldId(long fieldId)

Sets field ID value.

getStatHistory

public StatusHistoryValue getStatHistory()

Returns Status History field value.

setStatHistory

public void setStatHistory(StatusHistoryValue statHistory)

Sets Status History field value.

getServer

public java.lang.String getServer()

Returns the name of the server where the schema is located. For filters and escalations, specify the server where the filters or escalation is located (either by name or by passing @). For active links, specify * to retrieve the value from the current window.

setServer

public void setServer(java.lang.String server)

Sets the name of the server where the schema is located. For filters and escalations, specify the server where the filters or escalation is located (either by name or by passing @). For active links, specify * to retrieve the value from the current window.

getSchema

public NameID getSchema()

Returns the name of the schema containing the field value to assign. For filters and escalations, specify @ to retrieve or set the value from the current transaction. For active links, specify * to retrieve or set the value from the current window.

setSchema

public void setSchema(NameID schema)

Sets the name of the schema containing the field value to assign. For filters and escalations, specify @ to retrieve or set the value from the current transaction. For active links, specify * to retrieve or set the value from the current window.

getQualifier

public QualifierInfo getQualifier()

Returns the qualification that identifies the entries to retrieve (optional).

setQualifier

public void setQualifier(QualifierInfo qualifier)

Sets the qualification that identifies the entries to set (optional).

getTag

public int getTag()

Returns integer value indicating the type of field value to retrieve with the following constant values:

Parameters:

AR_FIELD - AR_FIELD

AR_STAT_HISTORY - AR_STAT_HISTORY

setTag

public void setTag(int tag)

Sets integer value indicating the type of field value to set with the following constant values:

Parameters:

AR_FIELD - AR_FIELD

AR_STAT_HISTORY - AR_STAT_HISTORY

getNoMatchOption

public long getNoMatchOption()

Returns integer value indicating the action to take if no entries match the search criteria. Use the following constant values:

Parameters:

AR_NO_MATCH_ERROR - AR_NO_MATCH_ERROR

AR_NO_MATCH_SET_NULL - AR_NO_MATCH_SET_NULL

AR_NO_MATCH_NO_ACTION - AR_NO_MATCH_NO_ACTION

AR_NO_MATCH_SUBMIT - AR_NO_MATCH_SUBMIT

setNoMatchOption

public void setNoMatchOption(long noMatchOption)

Sets integer value indicating the action to take if no entries match the search criteria. Use the following constant values:

Parameters:

AR_NO_MATCH_ERROR - AR_NO_MATCH_ERROR

AR_NO_MATCH_SET_NULL - AR_NO_MATCH_SET_NULL

AR_NO_MATCH_NO_ACTION - AR_NO_MATCH_NO_ACTION

AR_NO_MATCH_SUBMIT - AR_NO_MATCH_SUBMIT

getMultiMatchOption

public long getMultiMatchOption()

Returns option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields). Use the following constant values:

Parameters:

AR_MULTI_MATCH_ERROR - AR_MULTI_MATCH_ERROR

AR_MULTI_MATCH_SET_NULL - AR_MULTI_MATCH_SET_NULL

AR_MULTI_MATCH_USE_FIRST - AR_MULTI_MATCH_USE_FIRST

AR_MULTI_MATCH_PICKLIST - AR_MULTI_MATCH_PICKLIST

AR_MULTI_MATCH_MODIFY_ALL - AR_MULTI_MATCH_MODIFY_ALL

AR_MULTI_MATCH_NO_ACTION - AR_MULTI_MATCH_NO_ACTION

setMultiMatchOption

public void setMultiMatchOption(long multiMatchOption)

Sets option integer value indicating the action to take if multiple entries match the search criteria (Set Fields) or if any entry matches the search criteria (Push Fields). Use the following constant values:

Parameters:

AR_MULTI_MATCH_ERROR - AR_MULTI_MATCH_ERROR

AR_MULTI_MATCH_SET_NULL - AR_MULTI_MATCH_SET_NULL

AR_MULTI_MATCH_USE_FIRST - AR_MULTI_MATCH_USE_FIRST

AR_MULTI_MATCH_PICKLIST - AR_MULTI_MATCH_PICKLIST

AR_MULTI_MATCH_MODIFY_ALL - AR_MULTI_MATCH_MODIFY_ALL

AR_MULTI_MATCH_NO_ACTION - AR_MULTI_MATCH_NO_ACTION

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class java.lang.Object