com.filenet.rm.api.util

Class RMBulkOperationResult

  1. java.lang.Object
  2. extended bycom.filenet.rm.api.util.RMBulkOperationResult

  1. public class RMBulkOperationResult
  2. extends java.lang.Object
The RMBulkOperationResult class is a utility class that contains the result of bulk operations performed on each RMObject. The GUID of an RMObject can be retrieved using the getLabel() method. Additionally, the result of an operation can be retrieved using the getResult() method. You can instantiate the RMBulkOperationResult class by calling the default constructor of this class.

Constructor Summary

Constructor and Description
RMBulkOperationResult()
The default constructor used to retrieve an instance of this class.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getLabel()
Returns the member variable msObjectId.
  1. java.lang.String
getMessage()
Returns a String value that represents the result of a bulk operation.
  1. boolean
isSuccess()
Specifies whether the bulk operations that have been performed on an RMObject are successful or not.
  1. void
setLabel(java.lang.String asObjId)
Sets the value of the member variable msObjectId equal to the value provided in the input parameter.
  1. void
setResult(java.lang.String asMsg,boolean abSuccess)
Sets the value of the member variables msMsg and mbSuccess equal to the values provided in the input parameters.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RMBulkOperationResult

  1. public RMBulkOperationResult()
The default constructor used to retrieve an instance of this class.

Method Detail

setLabel

  1. public void setLabel(java.lang.String asObjId)
  2. throws RMException
Sets the value of the member variable msObjectId equal to the value provided in the input parameter.
Parameters:
asObjId - A String that represents the GUID of an RM entity on which an operation has been performed.
Throws:
RMException - In case of any error, an RMException will be thrown.

setResult

  1. public void setResult(java.lang.String asMsg,
  2. boolean abSuccess)
  3. throws RMException
Sets the value of the member variables msMsg and mbSuccess equal to the values provided in the input parameters.
Parameters:
asMsg - A String that represents the result of an operation that has been performed on an RM entity.
abSuccess - A boolean variable that represents the result of an operation that has been performed on an RM entity.
Throws:
RMException - In case of any error, an RMException will be thrown.

isSuccess

  1. public boolean isSuccess()
  2. throws RMException
Specifies whether the bulk operations that have been performed on an RMObject are successful or not.
Returns:
True, if the bulk operations are successful; else false.
Throws:
RMException - In case of any error, an RMException will be thrown.

getMessage

  1. public final java.lang.String getMessage( )
  2. throws RMException
Returns a String value that represents the result of a bulk operation.
Returns:
A String value that represents the result of an operation that has been performed on an RM entity. The result is either a String "SUCCESS" in case the operation has been successfully performed, or an error message in case any exception has been raised during the operation.
Throws:
RMException - In case of any error, an RMException will be thrown.

getLabel

  1. public final java.lang.String getLabel( )
  2. throws RMException
Returns the member variable msObjectId.
Returns:
A String that represents the GUID of an RM entity on which an operation has been performed.
Throws:
RMException - In case of any error, an RMException will be thrown.