Uses of Interface
org.nuclos.api.UID

Packages that use UID

Package	Description
org.nuclos.api
org.nuclos.api.authentication
org.nuclos.api.businessobject
org.nuclos.api.businessobject.facade
org.nuclos.api.businessobject.facade.thin
org.nuclos.api.common
org.nuclos.api.communication
org.nuclos.api.context
org.nuclos.api.context.communication
org.nuclos.api.generation
org.nuclos.api.objectimport
org.nuclos.api.print
org.nuclos.api.printout
org.nuclos.api.provider
org.nuclos.api.report
org.nuclos.api.service
org.nuclos.api.statemodel
org.nuclos.api.ui
org.nuclos.api.ui.dnd
org.nuclos.api.webclient
org.nuclos.api.ws

Uses of UID in org.nuclos.api

Methods in org.nuclos.api that return UID

Modifier and Type	Method	Description
UID	Direction.getEntityUid()	Returns the UID of the entity the BusinesObject bases on
UID	User.getId()
UID	Direction.getSearchFilterUid()	Return the UID of the searchfilter which will be applied to the result list of the BusinessObject one is navigating to

Uses of UID in org.nuclos.api.authentication

Methods in org.nuclos.api.authentication that return UID

Modifier and Type	Method	Description
UID	AuthenticationResult.getMandatorId()
UID	AuthenticationResult.getUserId()	Either username or user id must be specified.

Methods in org.nuclos.api.authentication with parameters of type UID

Modifier and Type	Method	Description
AuthenticationResult.Builder	AuthenticationResult.Builder.withMandatorId(UID mandatorId)	If mandators are in use, the new session will need a selected one, similar to the login with a web- or rich-client.
AuthenticationResult.Builder	AuthenticationResult.Builder.withUserId(UID userId)	Either username or user id must be specified.

Uses of UID in org.nuclos.api.businessobject

Methods in org.nuclos.api.businessobject that return UID

Modifier and Type	Method	Description
UID	Process.getEntityId()	Returns the Id of the entity
UID	BusinessObject.getEntityUid()	Returns the UID of the entity the BusinesObject bases on
UID	GenericBusinessObject.getEntityUid()	Returns the UID of the entity this GenericBusinessObject bases on
UID	Process.getId()	Returns the Id of the process

Constructors in org.nuclos.api.businessobject with parameters of type UID

Modifier	Constructor	Description
	Process(UID pId, UID pEntityId, Class<T> pType)	Constructor using the Id of the process, the Id of the entity and class-type of the BusinessObject

Uses of UID in org.nuclos.api.businessobject.facade

Methods in org.nuclos.api.businessobject.facade with parameters of type UID

Modifier and Type	Method	Description
void	Lockable.lock(UID ownerId)	Lock this business object by setting the given owner.

Uses of UID in org.nuclos.api.businessobject.facade.thin

Methods in org.nuclos.api.businessobject.facade.thin that return UID

Modifier and Type	Method	Description
UID	Stateful.getNuclosStateId()	Returns the id of the current status

Uses of UID in org.nuclos.api.common

Fields in org.nuclos.api.common with type parameters of type UID

Modifier and Type	Field	Description
static final ForeignKeyAttribute<UID>	NuclosUserCommunicationAccount.CommunicationPortId	Attribute: communicationPort Entity: nuclos_userCommunicationAccount DB-Name: STRUID_T_AD_COMPORT Data type: org.nuclos.api.UID Localized: false Output format: null Scale: null Precision: null
static final PrimaryKeyAttribute<UID>	NuclosUserCommunicationAccount.Id	Attribute: primaryKey Entity: nuclos_userCommunicationAccount DB-Name: STRUID Data type: org.nuclos.api.UID Localized: false Output format: null Scale: null Precision: null
static final ForeignKeyAttribute<UID>	NuclosUserCommunicationAccount.UserId	Attribute: user Entity: nuclos_userCommunicationAccount DB-Name: STRUID_T_MD_USER Data type: org.nuclos.api.UID Localized: false Output format: null Scale: null Precision: null

Methods in org.nuclos.api.common that return UID

Modifier and Type	Method	Description
UID	NuclosUser.getCommunicationAccountPhoneId()
UID	NuclosUserCommunicationAccount.getCommunicationPortId()
UID	NuclosMandator.getId()
UID	NuclosRole.getId()
UID	NuclosUser.getId()
UID	NuclosUserCommunicationAccount.getUserId()

Uses of UID in org.nuclos.api.communication

Methods in org.nuclos.api.communication that return UID

Modifier and Type	Method	Description
UID	CommunicationPort.getId()
UID	CommunicationPortFactory.InstanceContext.getPortId()	Nuclos generates Ids for all communication ports.

Uses of UID in org.nuclos.api.context

Methods in org.nuclos.api.context that return UID

Modifier and Type	Method	Description
UID	LayoutComponentContext.getEntityUid()	This method supplies the name of the underlying entity
UID	StateChangeContext.getSourceStateId()	Deprecated. use method StateChangeContext.getSourceState()
UID	StateChangeContext.getTargetStateId()	Deprecated. use method StateChangeContext.getTargetState()

Methods in org.nuclos.api.context with parameters of type UID

Modifier and Type	Method	Description
static void	MessageContext.navigate(BusinessObject<?> businessObject, UID searchFilterUid)
static void	MessageContext.navigate(BusinessObject<?> businessObject, UID searchFilterUid, boolean newTab)

Uses of UID in org.nuclos.api.context.communication

Methods in org.nuclos.api.context.communication that return UID

Modifier and Type	Method	Description
UID	PhoneCallNotificationContext.getFromUserId()	(could be null)
UID	PhoneCallNotificationContext.getToUserId()	(could be null)

Methods in org.nuclos.api.context.communication with parameters of type UID

Modifier and Type	Method	Description
void	PhoneCallNotificationContext.setFromUserId(UID fromUserId)
void	PhoneCallNotificationContext.setToUserId(UID toUserId)

Uses of UID in org.nuclos.api.generation

Methods in org.nuclos.api.generation that return UID

Modifier and Type	Method	Description
UID	Generation.getId()

Uses of UID in org.nuclos.api.objectimport

Methods in org.nuclos.api.objectimport that return UID

Modifier and Type	Method	Description
UID	ImportStructureDefinition.getId()	Id of the definition
UID	XmlImportStructureDefinition.getId()	Id of the definition

Uses of UID in org.nuclos.api.print

Methods in org.nuclos.api.print that return UID

Modifier and Type	Method	Description
UID	PrintProperties.getPrintServiceId()	get print service is used for printouts
UID	PrintProperties.getTrayId()	get tray of the print service

Methods in org.nuclos.api.print with parameters of type UID

Modifier and Type	Method	Description
void	PrintProperties.setPrintServiceId(UID printServiceId)	set print service UID used for printouts
void	PrintProperties.setTrayId(UID trayId)	set tray UID of the print service

Uses of UID in org.nuclos.api.printout

Methods in org.nuclos.api.printout that return UID

Modifier and Type	Method	Description
UID	Printout.getId()	returns the id of the printout object

Uses of UID in org.nuclos.api.provider

Methods in org.nuclos.api.provider that return UID

Modifier and Type	Method	Description
static UID	UserProvider.grantMandator(NuclosMandator mandator, NuclosUser user)	This method assigns a mandator to a given user.
static UID	UserProvider.grantRole(Class<? extends NuclosRole> role, NuclosUser user)	This method assigns a role to a given user.
static UID	UserProvider.grantRole(NuclosRole role, NuclosUser user)	This method assigns a role to a given user.
static UID	MandatorProvider.insert(String name)	This method creates a Mandator and returns the id of the new object.
static UID	MandatorProvider.insert(String name, NuclosMandator parentMandator)	This method creates a Mandator and returns the id of the new object.
static UID	UserProvider.insert(String username, String firstname, String lastname, String email, Boolean passwordChangeRequired)	Deprecated.
static UID	UserProvider.insert(String username, String firstname, String lastname, String email, String password, Boolean passwordChangeRequired)	Deprecated.
static UID	UserProvider.insert(NuclosUser user)	This method creates a Nuclos User and returns the id of the new object. A password will be generated and a default notification Email with the password will be send. A new user does not have any roles and therefore does not have any rights in Nuclos.
static UID	UserProvider.insert(NuclosUser user, String password)	This method creates a Nuclos User and returns the id of the new object. Sends a default notification Email with the password. A new user does not have any roles and therefore does not have any rights in Nuclos.
static UID	UserProvider.insert(NuclosUser user, String password, boolean sendNotification)	This method creates a Nuclos User and returns the id of the new object. A new user does not have any roles and therefore does not have any rights in Nuclos.

Methods in org.nuclos.api.provider that return types with arguments of type UID

Modifier and Type	Method	Description
static Optional<UID>	UserProvider.verifyPasswordResolveUserId(String username, String password)

Methods in org.nuclos.api.provider with parameters of type UID

Modifier and Type	Method	Description
static List<NuclosMail>	MailProvider.receive(UID incomingEmailServer, boolean bDeleteMails)	This method retrieves all NuclosMails that can be found in the folder specified in a specific incoming email server configuration.
static List<NuclosMail>	MailProvider.receive(UID incomingEmailServer, String folderFrom, boolean bDeleteMails)	This method retrieves all NuclosMails that can be found in the specified folder in a specific incoming email server configuration.
static NuclosFile	ReportProvider.run(UID outputFormatId, Map<String,Object> params, NuclosLocale locale)
static void	MailProvider.send(UID outgoingServer, InputStream is)	Takes an email as an .eml from an input stream and sends it via a specific outgoing server.
static void	MailProvider.send(UID outgoingServer, NuclosMail mail)	This method sends a NuclosMail via a specific outgoing server

Uses of UID in org.nuclos.api.report

Methods in org.nuclos.api.report that return UID

Modifier and Type	Method	Description
UID	OutputFormat.getId()	returns the id of the current format
UID	Report.getId()	returns the id of the current report object

Uses of UID in org.nuclos.api.service

Methods in org.nuclos.api.service that return UID

Modifier and Type	Method	Description
UID	UserService.grantMandator(NuclosMandator mandator, NuclosUser user)	This method assigns a mandator to a given user.
UID	UserService.grantRole(Class<? extends NuclosRole> role, NuclosUser user)	This method assigns a role to a given user.
UID	UserService.grantRole(NuclosRole role, NuclosUser user)	This method assigns a role to a given user.
UID	MandatorService.insert(String name)
UID	MandatorService.insert(String name, NuclosMandator parentMandator)
UID	UserService.insert(String username, String firstname, String lastname, String email, Boolean passwordChangeRequired)	Deprecated.
UID	UserService.insert(String username, String firstname, String lastname, String email, String password, Boolean passwordChangeRequired)	Deprecated.
UID	UserService.insert(NuclosUser user)	This method creates a Nuclos User and returns the id of the new object. A password will be generated and a default notification Email with the password will be send. A new user does not have any roles and therefore does not have any rights in Nuclos.
UID	UserService.insert(NuclosUser user, String password)	This method creates a Nuclos User and returns the id of the new object. Sends a default notification Email with the password. A new user does not have any roles and therefore does not have any rights in Nuclos.
UID	UserService.insert(NuclosUser user, String password, boolean sendNotification)	This method creates a Nuclos User and returns the id of the new object. A new user does not have any roles and therefore does not have any rights in Nuclos.

Methods in org.nuclos.api.service that return types with arguments of type UID

Modifier and Type	Method	Description
default Optional<UID>	UserService.verifyPasswordResolveUserId(String username, String password)	Will try to verify user/password against Nuclos User and on success return the UID.

Methods in org.nuclos.api.service with parameters of type UID

Modifier and Type	Method	Description
default List<NuclosMail>	MailService.receive(UID incomingEmailServer, boolean bDeleteMails)
default List<NuclosMail>	MailService.receive(UID incomingEmailServer, String folderFrom, boolean bDeleteMails)
NuclosFile	ReportService.run(UID outputFormatId, Map<String,Object> params, NuclosLocale locale)
default void	MailService.send(UID outgoingEmailServer, InputStream is)
default void	MailService.send(UID outgoingEmailServer, NuclosMail mail)

Uses of UID in org.nuclos.api.statemodel

Methods in org.nuclos.api.statemodel that return UID

Modifier and Type	Method	Description
UID	State.getId()	This method returns the Id of the current state object
UID	State.getModelId()	This method returns the id of the statemodel the current state object belongs to

Constructors in org.nuclos.api.statemodel with parameters of type UID

Modifier	Constructor	Description
	State(UID uid, String description, String name, Integer numeral, UID model)

Uses of UID in org.nuclos.api.ui

Methods in org.nuclos.api.ui that return UID

Modifier and Type	Method	Description
UID	ResultToolbarItemFactory.getEntityUid()	Returns the UID of the business object for the result list the button is shown in.

Method parameters in org.nuclos.api.ui with type arguments of type UID

Modifier and Type	Method	Description
boolean	ResultToolbarItemFactory.isAllowed(Set<UID> grantedActions)	Returns true if the user is allowed to use this button based on actions in T_AD_ACTION granted to him/her.

Uses of UID in org.nuclos.api.ui.dnd

Methods in org.nuclos.api.ui.dnd that return UID

Modifier and Type	Method	Description
UID	InstallContext.getEntityUid()	getEntityName entity name

Uses of UID in org.nuclos.api.webclient

Methods in org.nuclos.api.webclient that return UID

Modifier and Type	Method	Description
UID	WebclientUrl.getEntityId()
UID	WebclientUrl.getProcessId()

Methods in org.nuclos.api.webclient with parameters of type UID

Modifier and Type	Method	Description
void	WebclientUrl.setEntityId(UID entityId)
void	WebclientUrl.setProcessId(UID processId)

Uses of UID in org.nuclos.api.ws

Methods in org.nuclos.api.ws that return UID

Modifier and Type	Method	Description
UID	WebServiceObject.getUID()	Returns the UID of the Nuclos-WebService.