A licensable piece of software that people can register against, defining how long a licence lasts and which profile properties are written into the generated licence. An organisation can have many software products, and each registration a person completes creates a SoftwareRegistration holding the licence text produced for them.

Group: Database Entities

Implements: Serializable


Properties

PropertyReturnsDescription
descriptionStringText shown to the person on the registration page, which should explain what registering for this product gets them. New products created through the create factory method start with the placeholder text "New software product".
fixedPropertiesStringComma separated list of property names held fixed for this product, the counterpart to the required properties. It is stored as raw text and this entity provides no parsing helper for it. Null when nothing has been configured.
idlongThe database identifier of this software product.
requiredPropertiesStringComma separated list of property names which will be included in the generated licence file. Use getRequiredPropertyNames to read it as a list rather than parsing it yourself. Null when no properties have been configured.
requiredPropertyNamesList<String>Splits the required properties text on commas and returns the trimmed property names. Blank entries are dropped, and an empty list is returned when no required properties have been set. Not a mapped column, it is derived on each call.
validityDaysLongHow many days a licence issued for this product remains valid. Null when no expiry period has been configured.

Methods

getId() · setOrganisation(Organisation organisation) · getValidityDays() · setValidityDays(Long validityDays) · getRequiredProperties() · setRequiredProperties(String requiredProperties) · getFixedProperties() · setFixedProperties(String fixedProperties) · getDescription() · setDescription(String description) · getRequiredPropertyNames()

getId()

Returns: long

The database identifier of this software product.

setOrganisation(Organisation organisation)

Returns: void

Sets the organisation that owns this software product.

ParameterDescription
organisationthe owning organisation

getValidityDays()

Returns: Long

How many days a licence issued for this product remains valid. Null when no expiry period has been configured.

setValidityDays(Long validityDays)

Returns: void

Sets how many days a licence issued for this product remains valid.

ParameterDescription
validityDaysthe licence validity period in days, or null for no expiry period

getRequiredProperties()

Returns: String

Comma separated list of property names which will be included in the generated licence file. Use getRequiredPropertyNames to read it as a list rather than parsing it yourself. Null when no properties have been configured.

setRequiredProperties(String requiredProperties)

Returns: void

Sets the comma separated list of property names included in the generated licence file.

ParameterDescription
requiredPropertiesthe comma separated property names, or null for none

getFixedProperties()

Returns: String

Comma separated list of property names held fixed for this product, the counterpart to the required properties. It is stored as raw text and this entity provides no parsing helper for it. Null when nothing has been configured.

setFixedProperties(String fixedProperties)

Returns: void

Sets the comma separated list of fixed property names for this product.

ParameterDescription
fixedPropertiesthe comma separated property names, or null for none

getDescription()

Returns: String

Text shown to the person on the registration page, which should explain what registering for this product gets them. New products created through the create factory method start with the placeholder text "New software product".

setDescription(String description)

Returns: void

Sets the text shown to the person on the registration page.

ParameterDescription
descriptionthe description shown on the registration page

getRequiredPropertyNames()

Returns: List<String>

Splits the required properties text on commas and returns the trimmed property names. Blank entries are dropped, and an empty list is returned when no required properties have been set. Not a mapped column, it is derived on each call.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.