Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.tibco.bpm.web.client.services.actions.workviews
Class CreateWorkListView

    java.lang.Object
      com.tibco.bpm.web.client.services.actions.workviews.CreateWorkListView

All Implemented Interfaces:
  com.google.gwt.user.client.rpc.IsSerializable, OSAction<WorkListIDResult>, net.customware.gwt.dispatch.shared.Action<WorkListIDResult>

    public class CreateWorkListView

extends java.lang.Object
implements OSAction<WorkListIDResult>

Create a Work List View in BRM

Filtering, ordering and paging options can be specified to determine which items are returned.

©2011 TIBCO Software Inc.

Since:
  2.0.0
See Also:
  ``

Constructor Summary
`CreateWorkListView(java.lang.String name, java.lang.String description, java.lang.String customData, OrgModelEntity entity, java.lang.String order, java.lang.String filter, java.util.ArrayList<OrgModelEntity> authors, java.util.ArrayList<OrgModelEntity> users, java.lang.String ownerId, boolean publicView)` Constructs a new CreateWorkListView Action.

Method Summary
`java.util.ArrayList<OrgModelEntity>` | `getAuthors()` List of the authors of the View
`java.lang.String` | `getCustomData()` Custom data to associate with the View.
`java.lang.String` | `getDescription()` Description of the View
`OrgModelEntity` | `getEntity()` Entity of the work list to View
`java.lang.String` | `getFilter()` Filter string to pass to BRM.
`java.lang.String` | `getName()` Name of the View
`java.lang.String` | `getOrder()` Order string to pass to BRM.
`java.lang.String` | `getOwnerId()` Owner of the view
`java.util.ArrayList<OrgModelEntity>` | `getUsers()` List of the owners of the View
`boolean` | `isPublicView()` If the view is public

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### CreateWorkListView

    public CreateWorkListView(java.lang.String name,
                              java.lang.String description,
                              java.lang.String customData,
                              OrgModelEntity entity,
                              java.lang.String order,
                              java.lang.String filter,
                              java.util.ArrayList<OrgModelEntity> authors,
                              java.util.ArrayList<OrgModelEntity> users,
                              java.lang.String ownerId,
                              boolean publicView)

  Constructs a new CreateWorkListView Action.

  Parameters:
    `entity` - Org model this View will retrieve the items for.
    `name` - Name of the View.
    `description` - Description of the View.
    `customData` - Custom ( client-specific ) data to associate with the view.
    `order` - Order string to pass to BRM.

    An example would be :

    "appInstance ASC , appInstanceDescription ASC , id ASC , priority ASC , startDate ASC , endDate ASC , attribute1 ASC , attribute2 ASC , attribute3 ASC , attribute4 ASC"

    See the BRM Filter and Sort documentation for more details.

    `filter` - Filer string to pass to BRM.

    An example would be :

    "appInstance='instance' AND appInstanceDescription>'process1' AND description<'Step2'"

    See the BRM Filter and Sort documentation for more details.

    `authors` - List of the Authors for this View. Authors are allowed to edit the view.
    `owners` - List of the users for this View. Users will be able to see the view in their BPM client.
    `ownerId` - User ID ( GUID ) of the owner of the view.
    `publicView` - If the view is public anyone can access ( but not edit ) the view.

Method Detail

### getName

    public java.lang.String getName()

  Name of the View

  Returns:
    Name of the View.

### getDescription

    public java.lang.String getDescription()

  Description of the View

  Returns:
    Description of the View.

### getCustomData

    public java.lang.String getCustomData()

  Custom data to associate with the View.

  Returns:
    Custom data associated with the View.

### getOrder

    public java.lang.String getOrder()

  Order string to pass to BRM.

  An example would be :

  "appInstance ASC , appInstanceDescription ASC , id ASC , priority ASC , startDate ASC , endDate ASC , attribute1 ASC , attribute2 ASC , attribute3 ASC , attribute4 ASC"

  See the BRM Filter and Sort documentation for more details.

  Returns:
    Returns the order.

### getFilter

    public java.lang.String getFilter()

  Filter string to pass to BRM.

  An example would be :

  "appInstance='instance' AND appInstanceDescription>'process1' AND description<'Step2'"

  See the BRM Filter and Sort documentation for more details.

  Returns:
    Returns the filter.

### getEntity

    public OrgModelEntity getEntity()

  Entity of the work list to View

  Returns:
    Returns the entity.

### getAuthors

    public java.util.ArrayList<OrgModelEntity> getAuthors()

  List of the authors of the View

  Returns:
    Returns the list of authors.

### getUsers

    public java.util.ArrayList<OrgModelEntity> getUsers()

  List of the owners of the View

  Returns:
    Returns the list of owners.

### getOwnerId

    public java.lang.String getOwnerId()

  Owner of the view

  Returns:
    Returns the owner of the view, this will always be a resource GUID.

### isPublicView

    public boolean isPublicView()

  If the view is public

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2015 TIBCO Software Inc. All Rights Reserved.