Class ResultList

java.lang.Object
com.appiancorp.suiteapi.common.Result
com.appiancorp.suiteapi.common.ResultList
All Implemented Interfaces:
Serializable

public class ResultList extends Result
Class for storing the results returned by a service call. Service methods that return a ResultList will return successfully even if some of the requested entities cannot be retrieved on the server (unlike methods which return a ResultPage, which throw an exception if any one of the requested entities cannot be retrieved). The results that were successfully retrieved by the service call can be accessed using the Result.getResults() method of the Result base class. Additionally, getResultCodes() can be used to retrive the list of result codes that represent the successful retrieval of an entity, or, if the entity could not be retrieved on the server, the reason for the failure. Some possible result codes are defined by this class, although individual methods may list separate result codes. Every service method that returns a ResultList should document the code constants that are returned by that specific call.
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Constant indicating that a particular result in the ResultList is invalid (typically, there is no entity in the database which corresponds to the given ID).
    static final int
    Constant indicating that the user does not have sufficient privilege to view a particular result in the ResultList.
    static final int
    Constant indicating that user does not permission to publish a subprocess within the process model.
    static final int
    Constant indicating that the subprocess within a process model is invalid and hence cannot be published.
    static final int
    Constant indicating that a particular result in the ResultList is valid.
    static final int
    Constant used in the collaboration application, which indicates that the user has administrator privileges to a particular result in the ResultList.
    static final int
    Constant used in the collaboration application, which indicates that the user has editor privileges to a particular result in the ResultList.
    static final int
    Constant used in the portal application, which indicates that the user has administrator privileges to a particular result in the ResultList.
    static final int
    Constant used in the portal application, which indicates that the user has editor privileges to a particular result in the ResultList.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the result codes for each of the requested ids.
    void
    setResultCodes(Integer[] resultCodes_)
     

    Methods inherited from class com.appiancorp.suiteapi.common.Result

    getNumResults, getResults, setResults

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • COLLAB_CODE_CAN_ADMINISTRATE

      public static final int COLLAB_CODE_CAN_ADMINISTRATE
      Constant used in the collaboration application, which indicates that the user has administrator privileges to a particular result in the ResultList.
      See Also:
    • COLLAB_CODE_CAN_EDIT

      public static final int COLLAB_CODE_CAN_EDIT
      Constant used in the collaboration application, which indicates that the user has editor privileges to a particular result in the ResultList.
      See Also:
    • PORTAL_CODE_CAN_ADMINISTRATE

      public static final int PORTAL_CODE_CAN_ADMINISTRATE
      Constant used in the portal application, which indicates that the user has administrator privileges to a particular result in the ResultList.
      See Also:
    • PORTAL_CODE_CAN_EDIT

      public static final int PORTAL_CODE_CAN_EDIT
      Constant used in the portal application, which indicates that the user has editor privileges to a particular result in the ResultList.
      See Also:
    • CODE_NO_PERMISSION

      public static final int CODE_NO_PERMISSION
      Constant indicating that the user does not have sufficient privilege to view a particular result in the ResultList.
      See Also:
    • CODE_INVALID

      public static final int CODE_INVALID
      Constant indicating that a particular result in the ResultList is invalid (typically, there is no entity in the database which corresponds to the given ID).
      See Also:
    • CODE_VALID

      public static final int CODE_VALID
      Constant indicating that a particular result in the ResultList is valid.
      See Also:
    • CODE_SUBPROCESS_CANNOT_PUBLISH

      public static final int CODE_SUBPROCESS_CANNOT_PUBLISH
      Constant indicating that user does not permission to publish a subprocess within the process model.
      See Also:
    • CODE_SUBPROCESS_INVALID

      public static final int CODE_SUBPROCESS_INVALID
      Constant indicating that the subprocess within a process model is invalid and hence cannot be published.
      See Also:
  • Constructor Details

    • ResultList

      public ResultList()
  • Method Details

    • getResultCodes

      public Integer[] getResultCodes()
      Returns the result codes for each of the requested ids. Each code represents the successful retrieval of an object, or, if the object could not be retrieved, the reason for the failure. Some possible result codes are defined by this class, although individual methods may list separate result codes. Every service method that returns a ResultList should document the code constants that are returned by that specific call.
      Returns:
      The result codes for each of the requested ids
      See Also:
    • setResultCodes

      public void setResultCodes(Integer[] resultCodes_)
      Parameters:
      resultCodes_ - The result codes for each of the requested ids.
      See Also:
    • toString

      public String toString()
      Overrides:
      toString in class Result