com.jp.protection.pub.pro.ls
Interface LicenseStorage.LicenseEntry

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BasicLicenseStorage.BasicLicenseEntry
Enclosing interface:
LicenseStorage

public static interface LicenseStorage.LicenseEntry
extends java.io.Serializable

Interface describes single license stored in the license storage

Since:
3.0

Method Summary
 int getCheckoutPeriod()
          Returns license checkout period
 int getCPULimit()
          Retuens CPU core limit
 int getID()
          Returns unique identifier
 byte[] getLicenseBytes()
          Returns license bytes
 java.util.Date getLicenseIssueDate()
          Returns license issue date
 java.lang.String getLicenseNumber()
          Returns license number
 int getLicenseType()
          Returns license type
 int getLockPeriod()
          Returns license lock period
 java.lang.String getMainLicenseNumber()
          Returns main license number.
 int getMajorVersion()
          Returns major version
 long getMemoryLimit()
          Returns memory limit
 int getMinorVersion()
          Returns minor version
 java.lang.String getModifiedBy()
          Returns identifier of the app that created or modified that entry in the form of app_id:instance_id
 int getNumberCopies()
          Returns the number of copies
 java.lang.String getProduct()
          Returns product identifier
 java.lang.String getProductEdition()
          Returns product edition identifier
 int getState()
          Returns the state of the entry as one of License.STATE constants.
 int getSupplementalCPULimit()
          Returns the total CPU Core limit supplied by all the supplemental licenses.
 long getSupplementalMemoryLimit()
          Returns the total memory limit supplied by all the supplemental licenses.
 int getSupplementalNumberCopies()
          Returns number of copies supplied by all the supplemental licenses.
 int getSupplementalUsageLimit()
          Returns the total usage limit supplied by all the supplemental licenses.
 int getUsageLimit()
          Returns usage limit
 int getUserLicensingModel()
          Returns user licensing model
 boolean isSupplemental()
          Checks whether the license entry represents a supplemental license
 boolean isSupplementalFor(LicenseStorage.LicenseEntry aLicenseEntry)
          Checks whether the license entry represents a supplemental license
 boolean isValid()
          Returns whether the entry is valid.
 void setCheckoutPeriod(int aCheckoutPeriod)
           
 void setCPULimit(int aCPULimit)
           
 void setLicenseBytes(byte[] aLicenseBytes)
          Specifies license bytes for the entry
 void setLicenseIssueDate(java.util.Date aLicenseIssueDate)
           
 void setLicenseNumber(java.lang.String aLicenseNumber)
          Specifies license number for the entry
 void setLicenseType(int aLicenseType)
          Specifies license type for the entry
 void setLockPeriod(int aLockPeriod)
           
 void setMainLicenseNumber(java.lang.String aMainLicenseNumber)
          Specifies main license number for the entry.
 void setMajorVersion(int aMajorVersion)
          Specifies major version for the entry
 void setMemoryLimit(long aMemoryLimit)
           
 void setMinorVersion(int aMinorVersion)
          Specifies minor version for the entry
 void setModifiedBy(java.lang.String aModifiedBy)
           
 void setNumberCopies(int aNumberCopies)
           
 void setProduct(java.lang.String aProduct)
          Specifies product identifier for the entry
 void setProductEdition(java.lang.String aProductEdition)
          Specifies product edition identifier for the entry
 void setState(int aState)
          Specifies the state of the entry.
 void setSupplementalCPULimit(int aSupplementalCPULimit)
          Specifies the total CPU Core limit supplied by all the supplemental licenses.
 void setSupplementalMemoryLimit(long aSupplementalMemoryLimit)
          Specifies the total memory limit supplied by all the supplemental licenses.
 void setSupplementalNumberCopies(int aSupplementalNumberCopies)
          Specifies number of copies supplied by all the supplemental licenses.
 void setSupplementalUsageLimit(int aSupplementalUsageLimit)
          Specifies the total usage limit supplied by all the supplemental licenses.
 void setUsageLimit(int aUsageLimit)
           
 void setUserLicensingModel(int aUserLicensingModel)
          Specifies user licensing model for the entry
 void setValid(boolean aValid)
          Specifies that the license entry is valid.
 

Method Detail

getID

int getID()
Returns unique identifier

Returns:
unique (per License Storage) identifier

getLicenseBytes

byte[] getLicenseBytes()
Returns license bytes

Returns:
license bytes

setLicenseBytes

void setLicenseBytes(byte[] aLicenseBytes)
Specifies license bytes for the entry

Parameters:
aLicenseBytes - license bytes to set

getLicenseNumber

java.lang.String getLicenseNumber()
Returns license number

Returns:
license number

setLicenseNumber

void setLicenseNumber(java.lang.String aLicenseNumber)
Specifies license number for the entry

Parameters:
aLicenseNumber - license number to set

getLicenseType

int getLicenseType()
Returns license type

Returns:
license type

setLicenseType

void setLicenseType(int aLicenseType)
Specifies license type for the entry

Parameters:
aLicenseType - license type to set

getUserLicensingModel

int getUserLicensingModel()
Returns user licensing model

Returns:
user licensing model

setUserLicensingModel

void setUserLicensingModel(int aUserLicensingModel)
Specifies user licensing model for the entry

Parameters:
aUserLicensingModel - user licensing model to set

getProduct

java.lang.String getProduct()
Returns product identifier

Returns:
product identifier

setProduct

void setProduct(java.lang.String aProduct)
Specifies product identifier for the entry

Parameters:
aProduct - product identifier to set

getProductEdition

java.lang.String getProductEdition()
Returns product edition identifier

Returns:
product edition identifier

setProductEdition

void setProductEdition(java.lang.String aProductEdition)
Specifies product edition identifier for the entry

Parameters:
aProductEdition - product edition identifier to set

getMajorVersion

int getMajorVersion()
Returns major version

Returns:
major version

setMajorVersion

void setMajorVersion(int aMajorVersion)
Specifies major version for the entry

Parameters:
aMajorVersion - major version to set

getMinorVersion

int getMinorVersion()
Returns minor version

Returns:
minor version

setMinorVersion

void setMinorVersion(int aMinorVersion)
Specifies minor version for the entry

Parameters:
aMinorVersion - minor version to set

getMainLicenseNumber

java.lang.String getMainLicenseNumber()
Returns main license number. Note, reserved for use by Licensing Server.

Returns:
main license number
Since:
4.8.0

setMainLicenseNumber

void setMainLicenseNumber(java.lang.String aMainLicenseNumber)
Specifies main license number for the entry. Note, reserved for use by Licensing Server.

Parameters:
aMainLicenseNumber - main license number to set
Since:
4.8.0

isValid

boolean isValid()
Returns whether the entry is valid. Note, reserved for use by Licensing Server.

Returns:
true if the entry is valid; false otherwise
Since:
4.8.0

setValid

void setValid(boolean aValid)
Specifies that the license entry is valid. Note, reserved for use by Licensing Server.

Parameters:
aValid - true if the entry is valid
Since:
4.8.0

getState

int getState()
Returns the state of the entry as one of License.STATE constants. Note, reserved for use by Licensing Server.

Returns:
the state of the entry
Since:
5.0

setState

void setState(int aState)
Specifies the state of the entry. Note, reserved for use by Licensing Server.

Parameters:
aState - the state of the entry as one of License.STATE_ constants
Since:
4.8.0

getSupplementalNumberCopies

int getSupplementalNumberCopies()
Returns number of copies supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Returns:
umber of copies supplied by all the supplemental licenses
Since:
4.8.0

setSupplementalNumberCopies

void setSupplementalNumberCopies(int aSupplementalNumberCopies)
Specifies number of copies supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Parameters:
aSupplementalNumberCopies - number of copies supplied by all the supplemental licenses
Since:
4.8.0

isSupplemental

boolean isSupplemental()
Checks whether the license entry represents a supplemental license

Returns:
true if the license entry represents a supplemental license
Since:
4.8.0

isSupplementalFor

boolean isSupplementalFor(LicenseStorage.LicenseEntry aLicenseEntry)
Checks whether the license entry represents a supplemental license

Returns:
true if the license entry represents a supplemental license
Since:
5.0

getSupplementalUsageLimit

int getSupplementalUsageLimit()
Returns the total usage limit supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Returns:
total usage limit supplied by all the supplemental licenses
Since:
5.0

setSupplementalUsageLimit

void setSupplementalUsageLimit(int aSupplementalUsageLimit)
Specifies the total usage limit supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Parameters:
aSupplementalUsageLimit - total usage limit supplied by all the supplemental licenses
Since:
5.0

getSupplementalCPULimit

int getSupplementalCPULimit()
Returns the total CPU Core limit supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Returns:
total CPU Core limit supplied by all the supplemental licenses
Since:
5.0

setSupplementalCPULimit

void setSupplementalCPULimit(int aSupplementalCPULimit)
Specifies the total CPU Core limit supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Parameters:
aSupplementalCPULimit - total CPU Core limit supplied by all the supplemental licenses
Since:
5.0

getSupplementalMemoryLimit

long getSupplementalMemoryLimit()
Returns the total memory limit supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Returns:
memory limit supplied by all the supplemental licenses
Since:
5.0

setSupplementalMemoryLimit

void setSupplementalMemoryLimit(long aSupplementalMemoryLimit)
Specifies the total memory limit supplied by all the supplemental licenses. Note, reserved for use by Licensing Server.

Parameters:
aSupplementalMemoryLimit - memory limit supplied by all the supplemental licenses
Since:
5.0

getNumberCopies

int getNumberCopies()
Returns the number of copies

Returns:
number of copies
Since:
5.0

setNumberCopies

void setNumberCopies(int aNumberCopies)

getLicenseIssueDate

java.util.Date getLicenseIssueDate()
Returns license issue date

Returns:
license issue date
Since:
5.0

setLicenseIssueDate

void setLicenseIssueDate(java.util.Date aLicenseIssueDate)

getCPULimit

int getCPULimit()
Retuens CPU core limit

Returns:
CPU core limit
Since:
5.0

setCPULimit

void setCPULimit(int aCPULimit)

getMemoryLimit

long getMemoryLimit()
Returns memory limit

Returns:
memory limit
Since:
5.0

setMemoryLimit

void setMemoryLimit(long aMemoryLimit)

getLockPeriod

int getLockPeriod()
Returns license lock period

Returns:
license lock period
Since:
5.0

setLockPeriod

void setLockPeriod(int aLockPeriod)

getCheckoutPeriod

int getCheckoutPeriod()
Returns license checkout period

Returns:
license checkout period

setCheckoutPeriod

void setCheckoutPeriod(int aCheckoutPeriod)

getUsageLimit

int getUsageLimit()
Returns usage limit

Returns:
usage limit
Since:
5.0

setUsageLimit

void setUsageLimit(int aUsageLimit)

getModifiedBy

java.lang.String getModifiedBy()
Returns identifier of the app that created or modified that entry in the form of app_id:instance_id

Returns:
modified by
Since:
5.0

setModifiedBy

void setModifiedBy(java.lang.String aModifiedBy)