curam.cpm.facade.intf

Interface License

All Known Implementing Classes:

License, curam.cpm.facade.impl.License, LicenseFactory

@AccessLevel(value=EXTERNAL)
public interface License

This process class provides maintenance methods for License records.

Method Summary

Modifier and Type	Method and Description
void	addLicenseServiceOfferings(curam.cpm.facade.struct.LicenseServiceOfferingsSummaryDetails dtls) This method adds a License service offering to be covered by a License.
void	approveLicense(curam.cpm.facade.struct.LicenseProviderAndVersionNumberKey key) This method approves a License for a Provider.
void	cancelLicense(curam.cpm.facade.struct.LicenseProviderAndVersionNumberKey key) This method cancels a License for a Provider.
curam.cpm.facade.struct.InformationalMessageList	checkLicenseApprovalCriteria(curam.cpm.facade.struct.LicenseProviderAndVersionNumberKey key) This method checks if training requirements are specified for the license type, then all training marked as 'Required' must be 'Completed' or 'Waived' for all active provider members.
curam.cpm.sl.entity.struct.LicenseKey	createLicense(curam.cpm.facade.struct.LicenseSummaryDetails dtls) This method creates a License for a Provider.
curam.attachmentlink.struct.AttachmentLinkKey	createLicenseAttachment(curam.attachmentlink.struct.AttachmentLinkDetails attachmentLinkDetails) Method used to create attachment for Provider License.
void	deleteServiceOfferingLink(curam.cpm.facade.struct.LicenseServiceOfferingLinkVersionNumberKey key) This method deletes the link between a License and a Provider service offering.
curam.cpm.facade.struct.ProviderOfferingSummaryDetailsList	listActiveServiceOfferingsByProvider(curam.cpm.sl.entity.struct.ProviderKey key) This method retrieves a list of all of the active service offerings for a given Provider.
curam.attachmentlink.struct.ListAttachmentLinkDetails	listLicenseAttachment(curam.cpm.sl.entity.struct.LicenseKey licenseKey) Method used to list all the attachment for a provider license.
curam.cpm.facade.struct.LicenseSummaryDetailsList	listLicenses(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key) This method retrieves a list of Licenses for a Provider.
curam.cpm.facade.struct.LicenseServiceOfferingsSummaryDetailsList	listLicenseServiceOfferings(curam.cpm.facade.struct.LicenseIDProviderKey key) This method retrieves a list of the service offerings covered by a License.
curam.cpm.eua.facade.struct.LicenseSummaryList	listLicensesForProvider(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key) This method is intended to be used by users responsible for managing licenses to retrieve a list of licenses for a provider.
curam.cpm.facade.struct.LicenseStatusHistorySummaryDetailsList	listLicenseStatusHistory(curam.cpm.sl.entity.struct.LicenseKey key) This method retrieves a list of all of the License Status History records for a License.
curam.cpm.facade.struct.LicenseStatusHistoryDetailsList	listLicenseStatusHistoryDetails(curam.cpm.sl.entity.struct.LicenseKey key) This method is intended to be used by users responsible for managing licenses to retrieve a list of all of the License Status History records for a License.
curam.cpm.facade.struct.LicenseTypeList	listLicenseType() Lists all the license types.
curam.cpm.sl.struct.NonComplianceReasonList	listNonComplianceReasons() This method retrieves a list of all of the non-compliance reasons from the non-compliance reason codetable.
curam.cpm.facade.struct.LicenseTrainingRequirementDetailsList	listTrainingRequirementForLicenseType(curam.cpm.sl.entity.struct.LicenseTrainingRequirementReadmultiKey key) Lists Training Requirement for a License Type.
curam.cpm.sl.entity.struct.LicenseKey	modifyLicense(curam.cpm.facade.struct.LicenseSummaryDetails dtls) This method modifies a License for a Provider.
curam.cpm.facade.struct.LicenseCreateDetails	readLicenseCreateDetails() This method retrieves details needed such as default values needed for the creation of a License.
void	rejectLicense(curam.cpm.facade.struct.LicenseRejectionKey key) This method rejects a License for a Provider.
curam.cpm.sl.entity.struct.LicenseKey	renewLicense(curam.cpm.facade.struct.LicenseRenewalSummaryDetails dtls) This method renews a License for a Provider.
void	suspendLicense(curam.cpm.facade.struct.LicenseSuspensionKey key) This method suspends a License for a Provider.
curam.cpm.facade.struct.LicenseSummaryDetails	viewLicense(curam.cpm.sl.entity.struct.LicenseKey key) This method retrieves the License details for a Provider.
curam.cpm.facade.struct.LicenseStatusHistorySummaryDetails	viewLicenseStatusHistory(curam.cpm.facade.struct.LicenseAndStatusHistoryKey key) This method retrieves the License Status History record details for a License.
curam.cpm.facade.struct.LicenseTrainingRequirementDetails	viewTrainingRequirementForLicenseType(curam.cpm.sl.entity.struct.LicenseTrainingRequirementKey key) Reads Training Requirement for a License Type.

Method Detail

createLicense

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.LicenseKey createLicense(curam.cpm.facade.struct.LicenseSummaryDetails dtls)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

This method creates a License for a Provider. When you create a new License the renewed field is set to false. When a new License record is created the status of a License is set to 'In Progress'

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewLicense

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseSummaryDetails viewLicense(curam.cpm.sl.entity.struct.LicenseKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

This method retrieves the License details for a Provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyLicense

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.LicenseKey modifyLicense(curam.cpm.facade.struct.LicenseSummaryDetails dtls)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

This method modifies a License for a Provider. Optimistic locking is used in the modify process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelLicense

@AccessLevel(value=EXTERNAL)
void cancelLicense(curam.cpm.facade.struct.LicenseProviderAndVersionNumberKey key)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

This method cancels a License for a Provider. The record is logically deleted using optimistic locking. The lifecycle state of the License record is set to 'canceled'.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLicenses

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseSummaryDetailsList listLicenses(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

This method retrieves a list of Licenses for a Provider. The returned items are sorted by date issued (newest first).

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

approveLicense

@AccessLevel(value=EXTERNAL)
void approveLicense(curam.cpm.facade.struct.LicenseProviderAndVersionNumberKey key)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

This method approves a License for a Provider. A license notification is generated and raised when the License is approved. The lifecycle state of the License record is set to 'approved'.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

suspendLicense

@AccessLevel(value=EXTERNAL)
void suspendLicense(curam.cpm.facade.struct.LicenseSuspensionKey key)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

This method suspends a License for a Provider. A license notification is generated and raised when the License is suspended. The lifecycle state of the License record is set to 'suspended'.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

rejectLicense

@AccessLevel(value=EXTERNAL)
void rejectLicense(curam.cpm.facade.struct.LicenseRejectionKey key)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

This method rejects a License for a Provider. A license notification is generated and raised when the License is rejected. The lifecycle state of the License record is set to 'rejected'.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLicenseStatusHistory

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseStatusHistorySummaryDetailsList listLicenseStatusHistory(curam.cpm.sl.entity.struct.LicenseKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

This method retrieves a list of all of the License Status History records for a License. The returned list is not filtered or sorted.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

renewLicense

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.LicenseKey renewLicense(curam.cpm.facade.struct.LicenseRenewalSummaryDetails dtls)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

This method renews a License for a Provider. The renewed license is automatically approved with no status history comments. A License Renewal child record is also created. The lifecycle state of the License record is set to 'renewed'.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listNonComplianceReasons

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.struct.NonComplianceReasonList listNonComplianceReasons()
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

This method retrieves a list of all of the non-compliance reasons from the non-compliance reason codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLicenseServiceOfferings

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseServiceOfferingsSummaryDetailsList listLicenseServiceOfferings(curam.cpm.facade.struct.LicenseIDProviderKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

This method retrieves a list of the service offerings covered by a License. The returned list is not filtered or sorted.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addLicenseServiceOfferings

@AccessLevel(value=EXTERNAL)
void addLicenseServiceOfferings(curam.cpm.facade.struct.LicenseServiceOfferingsSummaryDetails dtls)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

This method adds a License service offering to be covered by a License.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

deleteServiceOfferingLink

@AccessLevel(value=EXTERNAL)
void deleteServiceOfferingLink(curam.cpm.facade.struct.LicenseServiceOfferingLinkVersionNumberKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

This method deletes the link between a License and a Provider service offering. These links are represented as license service offering records.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewLicenseStatusHistory

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseStatusHistorySummaryDetails viewLicenseStatusHistory(curam.cpm.facade.struct.LicenseAndStatusHistoryKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

This method retrieves the License Status History record details for a License.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listActiveServiceOfferingsByProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingSummaryDetailsList listActiveServiceOfferingsByProvider(curam.cpm.sl.entity.struct.ProviderKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

This method retrieves a list of all of the active service offerings for a given Provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readLicenseCreateDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseCreateDetails readLicenseCreateDetails()
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

This method retrieves details needed such as default values needed for the creation of a License.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewTrainingRequirementForLicenseType

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseTrainingRequirementDetails viewTrainingRequirementForLicenseType(curam.cpm.sl.entity.struct.LicenseTrainingRequirementKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Reads Training Requirement for a License Type.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listTrainingRequirementForLicenseType

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseTrainingRequirementDetailsList listTrainingRequirementForLicenseType(curam.cpm.sl.entity.struct.LicenseTrainingRequirementReadmultiKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Lists Training Requirement for a License Type.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLicenseType

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseTypeList listLicenseType()
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Lists all the license types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

checkLicenseApprovalCriteria

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.InformationalMessageList checkLicenseApprovalCriteria(curam.cpm.facade.struct.LicenseProviderAndVersionNumberKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

This method checks if training requirements are specified for the license type, then all training marked as 'Required' must be 'Completed' or 'Waived' for all active provider members. Only those provider members that don't have an End Date or an End Date in the future are considered. If this rule is not satisfied, the user is to be notified but will be allowed to continue.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createLicenseAttachment

@AccessLevel(value=EXTERNAL)
curam.attachmentlink.struct.AttachmentLinkKey createLicenseAttachment(curam.attachmentlink.struct.AttachmentLinkDetails attachmentLinkDetails)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Method used to create attachment for Provider License.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLicenseAttachment

@AccessLevel(value=EXTERNAL)
curam.attachmentlink.struct.ListAttachmentLinkDetails listLicenseAttachment(curam.cpm.sl.entity.struct.LicenseKey licenseKey)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Method used to list all the attachment for a provider license.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLicensesForProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.eua.facade.struct.LicenseSummaryList listLicensesForProvider(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

This method is intended to be used by users responsible for managing licenses to retrieve a list of licenses for a provider. The returned items are sorted by date issued (newest first).

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLicenseStatusHistoryDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.LicenseStatusHistoryDetailsList listLicenseStatusHistoryDetails(curam.cpm.sl.entity.struct.LicenseKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

This method is intended to be used by users responsible for managing licenses to retrieve a list of all of the License Status History records for a License. The returned list is not filtered or sorted.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException