InternalPseudoKey

Method Summary
boolean	approve() Approves this pseudo key. An internal validation is performed first and if the validation fails, this will fail and return false. This does not automatically approve the key.
Data	getAllData() Returns a Data object containing information on this activation key, features, and pricing.
Data	getData() Returns a Data object containing information on this activation key.
InternalKeyFeatures	getFeatures() Returns the features for this activation key.
String	getId() Returns the ID of the key
int	getMaximumSize() Returns the absolute maximum size limit in KB. No key setting can be greater than this size.
InternalKeyPricing	getPricing() Returns the pricing for this activation key.
String	getPricingModel() Returns the pricing model (standard, custom). If the pricing model has not been set, this will attempt to determine it.
String	getPricingPlan() Returns the pricing plan. If the pricing plan has not been set, this will return 'default'.
boolean	isActive() Returns true if this activation key has been activated.
boolean	isApproved() Returns true if the key has been approved.
boolean	isEnterprise() Returns true if the activation is associated with an enterprise.
boolean	isInProgress() Returns true if the key status is in progress.
boolean	isNeedsApproval() Returns true if the key status is pending approval.
boolean	isPalBillingEnabled() Returns true if pal billing is enabled.
boolean	isRevoked() Returns true if the key has been revoked
boolean	resetFromBackup(String backupId) Resets this key to the information from the backup.
boolean	restrictToPal(String palId) Restricts this activation key to the Pal identified by palId (GUID).
boolean	revoke() Sets the status of the activation key to revoked, preventing the creation of new transactions. Returns false if it fails for any reason.
boolean	setData(Data data) Sets specific values of the activation key from those in the Data object.
	setName(String name) Sets the name of this activation key.
	setPalBillingEnabled(boolean enabled) Enables/disables pal billing
	setPricingModel(String model) Sets the pricing model (standard, custom).
	setPricingPlan(String plan) Sets the pricing plan.
	setStatusAwaitingApproval() Sets the status to awaiting approval.
	setStatusInProgress() Sets the status to in progress.
	setStatusNeedsApproval() Sets the status to needs approval.
boolean	transferToEnterprise(String enterpriseId) Associates this activation key with the specified enterprise. This method returns false if the activation key is not currently associated with the system or if the logged in user is not on a system profile.
boolean	unbindFeatures() Disconnect features and associated with a new structure.
boolean	unbindPricing() Disconnect pricing and associated with a new structure.

Method Detail

---

boolean approve()

Approves this pseudo key. An internal validation is performed first and if the validation fails, this will fail and return false. This does not automatically approve the key.

Returns:  boolean

Since: 03-09-2010

---

Data getAllData()

Returns a Data object containing information on this activation key, features, and pricing.

Returns:  Data

Since: 05-13-2010

---

Data getData()

Returns a Data object containing information on this activation key.

Returns:  Data

Since: 03-09-2010

---

InternalKeyFeatures getFeatures()

Returns the features for this activation key.

Returns:  InternalKeyFeatures

Since: 05-06-2010

---

String getId()

Returns the ID of the key

Returns:  String

Since: 03-08-2010

---

int getMaximumSize()

Returns the absolute maximum size limit in KB. No key setting can be greater than this size.

Returns:  int

Since: 03-09-2010

---

InternalKeyPricing getPricing()

Returns the pricing for this activation key.

Returns:  InternalKeyPricing

Since: 05-06-2010

---

String getPricingModel()

Returns the pricing model (standard, custom). If the pricing model has not been set, this will attempt to determine it.

Returns:  String

Since: 03-09-2010

---

String getPricingPlan()

Returns the pricing plan. If the pricing plan has not been set, this will return 'default'.

Returns:  String

Since: 03-09-2010

---

boolean isActive()

Returns true if this activation key has been activated.

Returns:  boolean

Since: 03-09-2010

---

boolean isApproved()

Returns true if the key has been approved.

Returns:  boolean

Since: 03-09-2010

---

boolean isEnterprise()

Returns true if the activation is associated with an enterprise.

Returns:  boolean

Since: 03-09-2010

---

boolean isInProgress()

Returns true if the key status is in progress.

Returns:  boolean

Since: 03-09-2010

---

boolean isNeedsApproval()

Returns true if the key status is pending approval.

Returns:  boolean

Since: 03-09-2010

---

boolean isPalBillingEnabled()

Returns true if pal billing is enabled.

Returns:  boolean

Since: 05-30-2013

---

boolean isRevoked()

Returns true if the key has been revoked

Returns:  boolean

Since: 03-09-2010

---

boolean resetFromBackup(String backupId)

Resets this key to the information from the backup.

Parameters:

• String   backupId

Returns:  boolean

Since: 04-16-2010

---

boolean restrictToPal(String palId)

Restricts this activation key to the Pal identified by palId (GUID).

Parameters:

• String   palId

Returns:  boolean

Since: 03-09-2010

---

boolean revoke()

Sets the status of the activation key to revoked, preventing the creation of new transactions. Returns false if it fails for any reason.

Returns:  boolean

Since: 03-09-2010

---

boolean setData(Data data)

Sets specific values of the activation key from those in the Data object.

Parameters:

• Data   data

Returns:  boolean

Since: 03-09-2010

---

setName(String name)

Sets the name of this activation key.

Parameters:

• String   name  - key name. Required parameter. Maximum allowed size of parameter: 50

Since: 03-09-2010

---

setPalBillingEnabled(boolean enabled)

Enables/disables pal billing

Parameters:

• boolean   enabled

Since: 05-30-2013

---

setPricingModel(String model)

Sets the pricing model (standard, custom).

Parameters:

• String   model  - model: standard, custom. Required parameter. Maximum allowed size of parameter: 10

Since: 03-09-2010

---

setPricingPlan(String plan)

Sets the pricing plan.

Parameters:

• String   plan  - pricing plan name. Required parameter. Maximum allowed size of parameter: 30

Since: 03-09-2010

---

setStatusAwaitingApproval()

Sets the status to awaiting approval.

Since: 03-18-2010

---

setStatusInProgress()

Sets the status to in progress.

Since: 03-09-2010

---

setStatusNeedsApproval()

Sets the status to needs approval.

Since: 03-09-2010

---

boolean transferToEnterprise(String enterpriseId)

Associates this activation key with the specified enterprise. This method returns false if the activation key is not currently associated with the system or if the logged in user is not on a system profile.

Parameters:

• String   enterpriseId

Returns:  boolean

Since: 03-09-2010

---

boolean unbindFeatures()

Disconnect features and associated with a new structure.

Returns:  boolean

Since: 05-06-2010

---

boolean unbindPricing()

Disconnect pricing and associated with a new structure.

Returns:  boolean

Since: 05-06-2010