com.jp.protection.pub.pro.lserver
Interface LicensingServiceResult

All Known Subinterfaces:
LicensingServiceResult.CheckoutResult, LicensingServiceResult.LicenseResult
All Known Implementing Classes:
LicensingServiceResultImpl, LicensingServiceResultImpl.CheckoutResultImpl, LicensingServiceResultImpl.LicenseResultImpl

public interface LicensingServiceResult

The interface which represents result of Licensing Service operations

Since:
3.0

Nested Class Summary
static interface LicensingServiceResult.CheckoutResult
          The interface which represents result of checkoutLicense(...) operation
static class LicensingServiceResult.ErrorCode
           
static interface LicensingServiceResult.LicenseResult
          The interface which represents result of getLicense(...) operation
 
Field Summary
static java.lang.String PROPERTY_CPU_LIMIT
           
static java.lang.String PROPERTY_CPU_USAGE
           
static java.lang.String PROPERTY_MEMORY_LIMIT
           
static java.lang.String PROPERTY_MEMORY_USAGE
           
static java.lang.String PROPERTY_MESSAGE
           
static java.lang.String PROPERTY_RESULT
           
static java.lang.String PROPERTY_TICKET
           
static java.lang.String PROPERTY_USAGE_COUNT
           
static java.lang.String PROPERTY_USAGE_LIMIT
           
static int RESULT_ERROR
          Specifies that operation failed due to business logic reasons.
static int RESULT_LICENSE_REVOKED
          Specifies that license lock revocation has been requested by administrator
static int RESULT_OK
          Specifies that operation succeeded
static int RESULT_SESSION_EXPIRED
          Specifies that license session is expired
static int RESULT_SYSTEM_ERROR
          Specifies that operation failed due to unexpected system error.
 
Method Summary
 LicensingServiceResult.ErrorCode getErrorCode()
          Returns error code
 java.lang.String getMessage()
          Returns the message text associated with the result
 java.util.Map getProperties()
          Returns result properties
 int getResult()
          Returns result code of the operation as one of RESULT_ constants
 java.lang.String getTicket()
          Returns ticket value unique identifies a licensing session for acquired license lock
 

Field Detail

RESULT_OK

static final int RESULT_OK
Specifies that operation succeeded

See Also:
Constant Field Values

RESULT_ERROR

static final int RESULT_ERROR
Specifies that operation failed due to business logic reasons.

See Also:
Constant Field Values

RESULT_SYSTEM_ERROR

static final int RESULT_SYSTEM_ERROR
Specifies that operation failed due to unexpected system error.

See Also:
Constant Field Values

RESULT_LICENSE_REVOKED

static final int RESULT_LICENSE_REVOKED
Specifies that license lock revocation has been requested by administrator

See Also:
Constant Field Values

RESULT_SESSION_EXPIRED

static final int RESULT_SESSION_EXPIRED
Specifies that license session is expired

See Also:
Constant Field Values

PROPERTY_RESULT

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

PROPERTY_TICKET

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

PROPERTY_MESSAGE

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

PROPERTY_USAGE_COUNT

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

PROPERTY_USAGE_LIMIT

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

PROPERTY_CPU_USAGE

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

PROPERTY_CPU_LIMIT

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

PROPERTY_MEMORY_USAGE

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

PROPERTY_MEMORY_LIMIT

static final java.lang.String PROPERTY_MEMORY_LIMIT
See Also:
Constant Field Values
Method Detail

getMessage

java.lang.String getMessage()
Returns the message text associated with the result

Returns:
message text

getResult

int getResult()
Returns result code of the operation as one of RESULT_ constants

Returns:
result code of the operation

getTicket

java.lang.String getTicket()
Returns ticket value unique identifies a licensing session for acquired license lock

Returns:
ticket

getProperties

java.util.Map getProperties()
Returns result properties

Returns:
result properties
Since:
v5.0

getErrorCode

LicensingServiceResult.ErrorCode getErrorCode()
Returns error code

Returns:
error code
Since:
v5.0