com.waveset.object
Interface ViewConstants

All Known Subinterfaces:
UserViewConstants
All Known Implementing Classes:
AbstractViewHandler, WorkflowServices

public interface ViewConstants


Field Summary
static java.lang.String ATT_COMMAND
          The value of the "command" post data parameter from the last post.
static java.lang.String ATT_DERIVED_FORM
          If the view handler generates a form at runtime (such as the MissingFields option in the user view), this is where it is stored.
static java.lang.String ATT_ERRORS
          Tranient error messages for display.
static java.lang.String ATT_FORCE_VALIDATION
          Flag indicating that we should force validation to happen upon view refresh (normally this is not done).
static java.lang.String ATT_NO_VALIDATION
          Flag indiciating that validation should not be performed when the view is checked in.
static java.lang.String ATT_PROCESS_INPUTS
          Used to specify options and input variables for the process launched during checkin.
static java.lang.String ATT_REQUEST_STATE
          The RequestState object associated with the current HTTP request, passed down by GenericEditForm.
static java.lang.String ATT_RETURNING_FROM_REDIRECT
          A flag indicating that to the view handler that it's ok to continue processing the view checkin since we're returning successfully from a redirect from this view handler to another jsp
static java.lang.String ATT_SESSION
          The Lighthouse Session that was activated to handle the HTTP request.
static java.lang.String ATT_SPE_CONTEXT
          When the form requests an SPE context, it is accessible here.
static java.lang.String IDM_RESOURCE
           
static java.lang.String LIGHTHOUSE_RESOURCE
          The name and type of a special account object we build to represent the IDM repository user.
static java.lang.String OP_ALLOWED_WORK_ITEM_TRANSITIONS
          Some view pages support the automatic transition to the work item editing pages if the workflow immediately encounters a manual action owned by the user that checked in the view (aka a "workflow wizard").
static java.lang.String OP_BACKGROUND
          When set ensures that the workflow process launched during checkin is always run asynchronously.
static java.lang.String OP_DEFER_COMMIT
          Currently used only for the ResourceAccounts views, but could be more general.
static java.lang.String OP_FORM
          Specifies the name of the form to use when displaying and processing the view.
static java.lang.String OP_INTERACTIVE
          Option set by all interactive pages to allow views to determine if they are being called in an interactive context or not.
static java.lang.String OP_NEED_SPE_CONTEXT
          Option specifying that an SPE Context needs to be accessible during form processing in the ATT_SPE_CONTEXT attribute.
static java.lang.String OP_NO_DISABLE_HINT
          Used by the UserFindViewer.
static java.lang.String OP_NO_FETCH
          Used to indicate that resource accounts should not be fetched.
static java.lang.String OP_OBJECT_ID
          Recognized by createView.
static java.lang.String OP_OBJECT_TYPE
          Recognized by createView.
static java.lang.String OP_ORGANIZATION
          Recognized by createView, getView, and checkoutView.
static java.lang.String OP_PROCESS
          Specifies the name of the workflow process to launch when the view is checked in.
static java.lang.String OP_RAW
          If "true", this map option indicates we should leave resource account attributes raw, as they were when fetched from their respective resources.
static java.lang.String OP_TASK_RESULT
          May be set to the WavesetResult of a TaskInstance.
static java.lang.String RESULT_ALLOWED_WORK_ITEM_TRANSITIONS
          A result item that may contain a list of work item types.
static java.lang.String RESULT_CONTINUE
          A special WavesetResult item name that may be returnd by the view handler after checkin to indicate that we should continue editing the view, treating the save like a refresh instead.
static java.lang.String RESULT_KEEP_VIEW
          A special WavesetResult item name that may be returned by the view handler during checkin to indicate that the view should not be cleared since it will be used again.
static java.lang.String RESULT_REQUIRES_CHALLENGE
          A special WavesetResult item name that may be returned by the view handler during checkin to indicate that a redirect to the challenge URL (security/challengeLogin.jsp) should be done before completing the current checkin
static java.lang.String RESULT_TASK_STATUS
          The name of a WavesetResult item that carries the status of the workflow task launched to create or update an object.
static java.lang.String RESULT_USER
          the name of a WavesetResult item returned by convertView that holds the converted WSUser object.
static java.lang.String TASK_STATUS_ERROR
           
 

Field Detail

LIGHTHOUSE_RESOURCE

public static final java.lang.String LIGHTHOUSE_RESOURCE
The name and type of a special account object we build to represent the IDM repository user.

See Also:
Constant Field Values

IDM_RESOURCE

public static final java.lang.String IDM_RESOURCE
See Also:
Constant Field Values

OP_INTERACTIVE

public static final java.lang.String OP_INTERACTIVE
Option set by all interactive pages to allow views to determine if they are being called in an interactive context or not.

See Also:
Constant Field Values

OP_FORM

public static final java.lang.String OP_FORM
Specifies the name of the form to use when displaying and processing the view. If not specified there is a system defined default. Some views also allow you to specifiy the form with an attribute.

See Also:
Constant Field Values

OP_NO_FETCH

public static final java.lang.String OP_NO_FETCH
Used to indicate that resource accounts should not be fetched.

See Also:
Constant Field Values

OP_RAW

public static final java.lang.String OP_RAW
If "true", this map option indicates we should leave resource account attributes raw, as they were when fetched from their respective resources. Used to indicate that we should *not* apply any calculations to the view attributes. Do not overlay Role attributes; Do not apply meta-view; Do not allow any UserForm derivations/expansions into the view.

See Also:
Constant Field Values

OP_PROCESS

public static final java.lang.String OP_PROCESS
Specifies the name of the workflow process to launch when the view is checked in.

See Also:
Constant Field Values

OP_OBJECT_ID

public static final java.lang.String OP_OBJECT_ID
Recognized by createView. Specifies the object id used to get the initial organization for the new object.

See Also:
Constant Field Values

OP_OBJECT_TYPE

public static final java.lang.String OP_OBJECT_TYPE
Recognized by createView. Specifies the object type used to get the initial organization for the new object.

See Also:
Constant Field Values

OP_ORGANIZATION

public static final java.lang.String OP_ORGANIZATION
Recognized by createView, getView, and checkoutView. Specifies the initial organization for the new object in createView. Specifies the current organization for the the existing object in getView and checkoutView.

See Also:
Constant Field Values

OP_BACKGROUND

public static final java.lang.String OP_BACKGROUND
When set ensures that the workflow process launched during checkin is always run asynchronously. The default for most workflows is synchronous execution.

See Also:
Constant Field Values

OP_DEFER_COMMIT

public static final java.lang.String OP_DEFER_COMMIT
Currently used only for the ResourceAccounts views, but could be more general. When "true" indicates that the checkin of the object should be deferred until commitView is called from the workflow. This allows workflows to further process the view before the WSUser is updated in the repository. It is not on by default because it would be in compatible with pre-5.0SP1 custom workflows that are not calling commitView.

See Also:
Constant Field Values

OP_TASK_RESULT

public static final java.lang.String OP_TASK_RESULT
May be set to the WavesetResult of a TaskInstance. This is passed to the commitView method by some of the user provisioning workflows. In these cases, the commit detects changes to the IDM user object that need to be added as rows in the provisioning result table. But the provisioning result table is in the TaskInstance's WavesetResult.

See Also:
Constant Field Values

OP_ALLOWED_WORK_ITEM_TRANSITIONS

public static final java.lang.String OP_ALLOWED_WORK_ITEM_TRANSITIONS
Some view pages support the automatic transition to the work item editing pages if the workflow immediately encounters a manual action owned by the user that checked in the view (aka a "workflow wizard"). This option may be used to restrict the automatic transition to only those work items that have certain types. The value of the option must be a list of strings.

See Also:
Constant Field Values

OP_NO_DISABLE_HINT

public static final java.lang.String OP_NO_DISABLE_HINT
Used by the UserFindViewer. If "true", then the user icons will not be decorated with the disabled hints.

See Also:
Constant Field Values

OP_NEED_SPE_CONTEXT

public static final java.lang.String OP_NEED_SPE_CONTEXT
Option specifying that an SPE Context needs to be accessible during form processing in the ATT_SPE_CONTEXT attribute. This is really not a a view option, it is interpreted by the interactive form processor, but since it is related to ATT_SPE_CONTEXT, we define it here.

See Also:
Constant Field Values

ATT_ERRORS

public static final java.lang.String ATT_ERRORS
Tranient error messages for display. These can be set by both the view handler, and GenericEditForm during HTML generation.

See Also:
Constant Field Values

ATT_COMMAND

public static final java.lang.String ATT_COMMAND
The value of the "command" post data parameter from the last post. This is passed down by GenericEditForm. It is sometimes convenient to have this in the view handler to adjust behavior.

See Also:
Constant Field Values

ATT_DERIVED_FORM

public static final java.lang.String ATT_DERIVED_FORM
If the view handler generates a form at runtime (such as the MissingFields option in the user view), this is where it is stored.

See Also:
Constant Field Values

ATT_NO_VALIDATION

public static final java.lang.String ATT_NO_VALIDATION
Flag indiciating that validation should not be performed when the view is checked in. Used when simulating a "soft cancel" button.

See Also:
Constant Field Values

ATT_FORCE_VALIDATION

public static final java.lang.String ATT_FORCE_VALIDATION
Flag indicating that we should force validation to happen upon view refresh (normally this is not done).

See Also:
Constant Field Values

ATT_REQUEST_STATE

public static final java.lang.String ATT_REQUEST_STATE
The RequestState object associated with the current HTTP request, passed down by GenericEditForm. This was added in 4.0SP1, among other things it allows the form expressions to have access to the HttpSession incase the page wants to manage its own persistent session data that is independent of the view.

See Also:
Constant Field Values

ATT_SESSION

public static final java.lang.String ATT_SESSION
The Lighthouse Session that was activated to handle the HTTP request.

See Also:
Constant Field Values

ATT_SPE_CONTEXT

public static final java.lang.String ATT_SPE_CONTEXT
When the form requests an SPE context, it is accessible here.

See Also:
Constant Field Values

ATT_PROCESS_INPUTS

public static final java.lang.String ATT_PROCESS_INPUTS
Used to specify options and input variables for the process launched during checkin.

See Also:
Constant Field Values

ATT_RETURNING_FROM_REDIRECT

public static final java.lang.String ATT_RETURNING_FROM_REDIRECT
A flag indicating that to the view handler that it's ok to continue processing the view checkin since we're returning successfully from a redirect from this view handler to another jsp

See Also:
Constant Field Values

RESULT_CONTINUE

public static final java.lang.String RESULT_CONTINUE
A special WavesetResult item name that may be returnd by the view handler after checkin to indicate that we should continue editing the view, treating the save like a refresh instead. Used only by complex views (e.g. user view) which may want to display multiple "pages" over the same view, but still allowing each form to use the standard Save button.

See Also:
Constant Field Values

RESULT_KEEP_VIEW

public static final java.lang.String RESULT_KEEP_VIEW
A special WavesetResult item name that may be returned by the view handler during checkin to indicate that the view should not be cleared since it will be used again. This is useful when we need to redirect to another jsp/view and then return to this view to let the view handler complete checkin

See Also:
Constant Field Values

RESULT_REQUIRES_CHALLENGE

public static final java.lang.String RESULT_REQUIRES_CHALLENGE
A special WavesetResult item name that may be returned by the view handler during checkin to indicate that a redirect to the challenge URL (security/challengeLogin.jsp) should be done before completing the current checkin

See Also:
Constant Field Values

RESULT_TASK_STATUS

public static final java.lang.String RESULT_TASK_STATUS
The name of a WavesetResult item that carries the status of the workflow task launched to create or update an object. May be used by the GUI to determine whether or not to cycle back on the edit page to retry after an error.

This will be set to "error" if an attempt to update the object fails for any reason.

See Also:
Constant Field Values

TASK_STATUS_ERROR

public static final java.lang.String TASK_STATUS_ERROR
See Also:
Constant Field Values

RESULT_USER

public static final java.lang.String RESULT_USER
the name of a WavesetResult item returned by convertView that holds the converted WSUser object.

See Also:
Constant Field Values

RESULT_ALLOWED_WORK_ITEM_TRANSITIONS

public static final java.lang.String RESULT_ALLOWED_WORK_ITEM_TRANSITIONS
A result item that may contain a list of work item types. This is recognized by pages that support the automatic transition to the work item editing page if the workflow launched by the view encounters a manual action owned by the same user that launched the workflow (aka a "workflow wizard"). Some pages however use ManualActions for approvals and to force the workflow into the background. The WorkItems generated for these should not cause automatic transition. The view handlers for these pages may set this result item to constrain which work item types we will automatically transition to. This is used by the User view, the value is taken from the OP_WORK_ITEM_TRANSITIONS option which is typically specified as a property in the form. If this property is not specified the view handler will set this to an empty list to prevent any transitions.

See Also:
Constant Field Values