Package org.cyclos.entities.users

Class Product

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.NamedEntity

org.cyclos.entities.ConfigurationEntity

org.cyclos.entities.users.Product

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, ProcessableForProxying, DefinesNetwork, IProduct, IEntity, IInternalNamedEntity, INamedEntity

Direct Known Subclasses:

MemberProduct, UserManagementProduct

@Entity
public abstract class Product
extends ConfigurationEntity
implements DefinesNetwork, IProduct

A Product contains permissions and relationships with other entities, and may be associated to BasicGroups (including Groups and GroupSets) or individual Users

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Field Summary

Fields

Modifier and Type	Field	Description
protected UserAccountType	userAccount

Constructor Summary

Constructors

Constructor	Description
Product()

Method Summary

Modifier and Type	Method	Description
protected Set<PaymentTransferType>	filterPaymentTypes(Collection<PaymentTransferType> paymentTypes, TransferTypeDirection direction)
Set<BasicGroup>	getAccessibleUserGroups()
Set<Agreement>	getAgreements()
String	getChannelIds()
Set<Channel>	getChannels()
DataTranslationType	getDataTranslationType()	If this entity allows data translation, should return the translation type
Set<ProductQuickAccess>	getDefaultQuickAccess()
Set<DocumentCategory>	getDocumentCategoryView()
Set<? extends BasicGroup>	getGroups()
Set<BasicGroup>	getGroupsForUserDirectory()
Integer	getMaxAddresses()
Integer	getMaxCustomImages()
Integer	getMaxInvitationRecipients()
Integer	getMaxLandlinePhones()
Integer	getMaxMessageRecipients()
Integer	getMaxMobilePhones()
Integer	getMaxProfileImages()
Integer	getMaxSmsPerMonth()
Set<ProductMyAccessClient>	getMyAccessClients()
Set<ProductMyContactField>	getMyContactFields()
Set<ProductMyProfileField>	getMyProfileFields()
Set<ProductMyRecordType>	getMyRecordTypes()
abstract ProductNature	getNature()
Network	getNetwork()	Returns the network this entity belongs to
Set<MyProductPasswordAction>	getPasswordActions()
Set<Permission>	getPermissions()
String	getPrincipalTypeIds()
Set<PrincipalType>	getPrincipalTypes()
Role	getRole()
Set<CustomWebService>	getRunCustomWebServices()
Set<CustomOperation>	getRunTransferCustomOperations()
Set<ProfileField>	getSimpleUserSearchProfileFields()
Set<ProductTransferStatusFlow>	getTransferStatusFlows()
UserGroupAccessibility	getUserDirectoryOnGroups()
UserGroupAccessibility	getUserGroupAccessibility()
Set<ProductUserProfileField>	getUserProfileFields()
Set<TransactionCustomField>	getVisibleTransactionFields()
Set<VoucherCustomField>	getVisibleVoucherFields()
void	setAccessibleUserGroups(Set<BasicGroup> accessibleUserGroups)
void	setAgreements(Set<Agreement> agreements)
void	setChannelIds(String channelIds)
void	setChannels(Set<Channel> channels)
void	setDefaultQuickAccess(Set<ProductQuickAccess> defaultQuickAccess)
void	setDocumentCategoryView(Set<DocumentCategory> documentCategoryView)
void	setGroups(Set<? extends BasicGroup> groups)
void	setGroupsForUserDirectory(Set<BasicGroup> groupsForUserDirectory)
void	setMaxAddresses(Integer maxAddresses)
void	setMaxCustomImages(Integer maxCustomImages)
void	setMaxInvitationRecipients(Integer maxInvitationRecipients)
void	setMaxLandlinePhones(Integer maxLandlinePhones)
void	setMaxMessageRecipients(Integer maxMessageRecipients)
void	setMaxMobilePhones(Integer maxMobilePhones)
void	setMaxProfileImages(Integer maxProfileImages)
void	setMaxSmsPerMonth(Integer maxSmsPerMonth)
void	setMyAccessClients(Set<ProductMyAccessClient> myAccessClients)
void	setMyContactFields(Set<ProductMyContactField> myContactFields)
void	setMyProfileFields(Set<ProductMyProfileField> myProfileFields)
void	setMyRecordTypes(Set<ProductMyRecordType> myRecordTypes)
void	setNetwork(Network network)
void	setPasswordActions(Set<MyProductPasswordAction> passwordActions)
void	setPrincipalTypeIds(String principalTypeIds)
void	setPrincipalTypes(Set<PrincipalType> principalTypes)
void	setRunCustomWebServices(Set<CustomWebService> runCustomWebServices)
void	setRunTransferCustomOperations(Set<CustomOperation> runTransferCustomOperations)
void	setSimpleUserSearchProfileFields(Set<ProfileField> profileFields)
void	setTransferStatusFlows(Set<ProductTransferStatusFlow> transferStatusFlows)
void	setUserDirectoryOnGroups(UserGroupAccessibility userDirectoryOnGroups)
void	setUserGroupAccessibility(UserGroupAccessibility userGroupAccessibility)
void	setUserProfileFields(Set<ProductUserProfileField> userProfileFields)
void	setVisibleTransactionFields(Set<TransactionCustomField> visibleTransactionFields)
void	setVisibleVoucherFields(Set<VoucherCustomField> visibleVoucherFields)

Methods inherited from class org.cyclos.entities.ConfigurationEntity

getDescription, getInternalName, setDescription, setInternalName, toShortString, toString

Methods inherited from class org.cyclos.entities.NamedEntity

compareTo, getName, getNames, setName

Methods inherited from class org.cyclos.entities.BaseEntity

getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.model.IInternalNamedEntity

matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Field Detail

userAccount

protected UserAccountType userAccount

Constructor Detail

Product

public Product()

Method Detail

getAccessibleUserGroups

public Set<BasicGroup> getAccessibleUserGroups()

getAgreements

public Set<Agreement> getAgreements()

getChannelIds

public String getChannelIds()

getChannels

public Set<Channel> getChannels()

getDataTranslationType

public DataTranslationType getDataTranslationType()

Description copied from class: BaseEntity

If this entity allows data translation, should return the translation type

Overrides:

getDataTranslationType in class BaseEntity

getDefaultQuickAccess

public Set<ProductQuickAccess> getDefaultQuickAccess()

getDocumentCategoryView

public Set<DocumentCategory> getDocumentCategoryView()

getGroups

public Set<? extends BasicGroup> getGroups()

getGroupsForUserDirectory

public Set<BasicGroup> getGroupsForUserDirectory()

getMaxAddresses

public Integer getMaxAddresses()

getMaxCustomImages

public Integer getMaxCustomImages()

getMaxInvitationRecipients

public Integer getMaxInvitationRecipients()

getMaxLandlinePhones

public Integer getMaxLandlinePhones()

getMaxMessageRecipients

public Integer getMaxMessageRecipients()

getMaxMobilePhones

public Integer getMaxMobilePhones()

getMaxProfileImages

public Integer getMaxProfileImages()

getMaxSmsPerMonth

public Integer getMaxSmsPerMonth()

getMyAccessClients

public Set<ProductMyAccessClient> getMyAccessClients()

getMyContactFields

public Set<ProductMyContactField> getMyContactFields()

getMyProfileFields

public Set<ProductMyProfileField> getMyProfileFields()

getMyRecordTypes

public Set<ProductMyRecordType> getMyRecordTypes()

getNature

public abstract ProductNature getNature()

getNetwork

public Network getNetwork()

Description copied from interface: HasNetwork

Returns the network this entity belongs to

Specified by:

getNetwork in interface HasNetwork

getPasswordActions

public Set<MyProductPasswordAction> getPasswordActions()

getPermissions

public Set<Permission> getPermissions()

getPrincipalTypeIds

public String getPrincipalTypeIds()

getPrincipalTypes

public Set<PrincipalType> getPrincipalTypes()

getRole

public Role getRole()

Specified by:

getRole in interface IProduct

getRunCustomWebServices

public Set<CustomWebService> getRunCustomWebServices()

getRunTransferCustomOperations

public Set<CustomOperation> getRunTransferCustomOperations()

getSimpleUserSearchProfileFields

public Set<ProfileField> getSimpleUserSearchProfileFields()

getTransferStatusFlows

public Set<ProductTransferStatusFlow> getTransferStatusFlows()

getUserDirectoryOnGroups

public UserGroupAccessibility getUserDirectoryOnGroups()

getUserGroupAccessibility

public UserGroupAccessibility getUserGroupAccessibility()

getUserProfileFields

public Set<ProductUserProfileField> getUserProfileFields()

getVisibleTransactionFields

public Set<TransactionCustomField> getVisibleTransactionFields()

getVisibleVoucherFields

public Set<VoucherCustomField> getVisibleVoucherFields()

setAccessibleUserGroups

public void setAccessibleUserGroups(Set<BasicGroup> accessibleUserGroups)

setAgreements

public void setAgreements(Set<Agreement> agreements)

setChannelIds

public void setChannelIds(String channelIds)

setChannels

public void setChannels(Set<Channel> channels)

setDefaultQuickAccess

public void setDefaultQuickAccess(Set<ProductQuickAccess> defaultQuickAccess)

setDocumentCategoryView

public void setDocumentCategoryView(Set<DocumentCategory> documentCategoryView)

setGroups

public void setGroups(Set<? extends BasicGroup> groups)

setGroupsForUserDirectory

public void setGroupsForUserDirectory(Set<BasicGroup> groupsForUserDirectory)

setMaxAddresses

public void setMaxAddresses(Integer maxAddresses)

setMaxCustomImages

public void setMaxCustomImages(Integer maxCustomImages)

setMaxInvitationRecipients

public void setMaxInvitationRecipients(Integer maxInvitationRecipients)

setMaxLandlinePhones

public void setMaxLandlinePhones(Integer maxLandlinePhones)

setMaxMessageRecipients

public void setMaxMessageRecipients(Integer maxMessageRecipients)

setMaxMobilePhones

public void setMaxMobilePhones(Integer maxMobilePhones)

setMaxProfileImages

public void setMaxProfileImages(Integer maxProfileImages)

setMaxSmsPerMonth

public void setMaxSmsPerMonth(Integer maxSmsPerMonth)

setMyAccessClients

public void setMyAccessClients(Set<ProductMyAccessClient> myAccessClients)

setMyContactFields

public void setMyContactFields(Set<ProductMyContactField> myContactFields)

setMyProfileFields

public void setMyProfileFields(Set<ProductMyProfileField> myProfileFields)

setMyRecordTypes

public void setMyRecordTypes(Set<ProductMyRecordType> myRecordTypes)

setNetwork

public void setNetwork(Network network)

Specified by:

setNetwork in interface DefinesNetwork

setPasswordActions

public void setPasswordActions(Set<MyProductPasswordAction> passwordActions)

setPrincipalTypeIds

public void setPrincipalTypeIds(String principalTypeIds)

setPrincipalTypes

public void setPrincipalTypes(Set<PrincipalType> principalTypes)

setRunCustomWebServices

public void setRunCustomWebServices(Set<CustomWebService> runCustomWebServices)

setRunTransferCustomOperations

public void setRunTransferCustomOperations(Set<CustomOperation> runTransferCustomOperations)

setSimpleUserSearchProfileFields

public void setSimpleUserSearchProfileFields(Set<ProfileField> profileFields)

setTransferStatusFlows

public void setTransferStatusFlows(Set<ProductTransferStatusFlow> transferStatusFlows)

setUserDirectoryOnGroups

public void setUserDirectoryOnGroups(UserGroupAccessibility userDirectoryOnGroups)

setUserGroupAccessibility

public void setUserGroupAccessibility(UserGroupAccessibility userGroupAccessibility)

setUserProfileFields

public void setUserProfileFields(Set<ProductUserProfileField> userProfileFields)

setVisibleTransactionFields

public void setVisibleTransactionFields(Set<TransactionCustomField> visibleTransactionFields)

setVisibleVoucherFields

public void setVisibleVoucherFields(Set<VoucherCustomField> visibleVoucherFields)

filterPaymentTypes

protected Set<PaymentTransferType> filterPaymentTypes(Collection<PaymentTransferType> paymentTypes,
                                                      TransferTypeDirection direction)