generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXuser.html Maven / Gradle / Ivy
NXuser (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXuser
-
- All Known Implementing Classes:
- NXuserImpl
public interface NXuser
extends NXobject
Contact information for a user.
The format allows more
than one user with the same affiliation and contact information,
but a second :ref:`NXuser` group should be used if they have different
affiliations, etc.
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.String
NX_ADDRESS
static java.lang.String
NX_AFFILIATION
static java.lang.String
NX_EMAIL
static java.lang.String
NX_FACILITY_USER_ID
static java.lang.String
NX_FAX_NUMBER
static java.lang.String
NX_NAME
static java.lang.String
NX_ROLE
static java.lang.String
NX_TELEPHONE_NUMBER
-
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type
Method and Description
IDataset
getAddress()
Address of user
java.lang.String
getAddressScalar()
Address of user
IDataset
getAffiliation()
Affiliation of user
java.lang.String
getAffiliationScalar()
Affiliation of user
IDataset
getEmail()
Email of user
java.lang.String
getEmailScalar()
Email of user
IDataset
getFacility_user_id()
facility based unique identifier for this person
e.g.
java.lang.String
getFacility_user_idScalar()
facility based unique identifier for this person
e.g.
IDataset
getFax_number()
Fax number of user
java.lang.String
getFax_numberScalar()
Fax number of user
IDataset
getName()
Name of user responsible for this entry
java.lang.String
getNameScalar()
Name of user responsible for this entry
IDataset
getRole()
Role of user responsible for this entry.
java.lang.String
getRoleScalar()
Role of user responsible for this entry.
IDataset
getTelephone_number()
Telephone number of user
java.lang.String
getTelephone_numberScalar()
Telephone number of user
DataNode
setAddress(IDataset address)
Address of user
DataNode
setAddressScalar(java.lang.String address)
Address of user
DataNode
setAffiliation(IDataset affiliation)
Affiliation of user
DataNode
setAffiliationScalar(java.lang.String affiliation)
Affiliation of user
DataNode
setEmail(IDataset email)
Email of user
DataNode
setEmailScalar(java.lang.String email)
Email of user
DataNode
setFacility_user_id(IDataset facility_user_id)
facility based unique identifier for this person
e.g.
DataNode
setFacility_user_idScalar(java.lang.String facility_user_id)
facility based unique identifier for this person
e.g.
DataNode
setFax_number(IDataset fax_number)
Fax number of user
DataNode
setFax_numberScalar(java.lang.String fax_number)
Fax number of user
DataNode
setName(IDataset name)
Name of user responsible for this entry
DataNode
setNameScalar(java.lang.String name)
Name of user responsible for this entry
DataNode
setRole(IDataset role)
Role of user responsible for this entry.
DataNode
setRoleScalar(java.lang.String role)
Role of user responsible for this entry.
DataNode
setTelephone_number(IDataset telephone_number)
Telephone number of user
DataNode
setTelephone_numberScalar(java.lang.String telephone_number)
Telephone number of user
-
Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField
-
Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool
-
Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode
-
-
Field Detail
-
NX_NAME
static final java.lang.String NX_NAME
- See Also:
- Constant Field Values
-
NX_ROLE
static final java.lang.String NX_ROLE
- See Also:
- Constant Field Values
-
NX_AFFILIATION
static final java.lang.String NX_AFFILIATION
- See Also:
- Constant Field Values
-
NX_ADDRESS
static final java.lang.String NX_ADDRESS
- See Also:
- Constant Field Values
-
NX_TELEPHONE_NUMBER
static final java.lang.String NX_TELEPHONE_NUMBER
- See Also:
- Constant Field Values
-
NX_FAX_NUMBER
static final java.lang.String NX_FAX_NUMBER
- See Also:
- Constant Field Values
-
NX_EMAIL
static final java.lang.String NX_EMAIL
- See Also:
- Constant Field Values
-
NX_FACILITY_USER_ID
static final java.lang.String NX_FACILITY_USER_ID
- See Also:
- Constant Field Values
-
Method Detail
-
getName
IDataset getName()
Name of user responsible for this entry
- Returns:
- the value.
-
setName
DataNode setName(IDataset name)
Name of user responsible for this entry
- Parameters:
name
- the name
-
getNameScalar
java.lang.String getNameScalar()
Name of user responsible for this entry
- Returns:
- the value.
-
setNameScalar
DataNode setNameScalar(java.lang.String name)
Name of user responsible for this entry
- Parameters:
name
- the name
-
getRole
IDataset getRole()
Role of user responsible for this entry.
Suggested roles are "local_contact",
"principal_investigator", and "proposer"
- Returns:
- the value.
-
setRole
DataNode setRole(IDataset role)
Role of user responsible for this entry.
Suggested roles are "local_contact",
"principal_investigator", and "proposer"
- Parameters:
role
- the role
-
getRoleScalar
java.lang.String getRoleScalar()
Role of user responsible for this entry.
Suggested roles are "local_contact",
"principal_investigator", and "proposer"
- Returns:
- the value.
-
setRoleScalar
DataNode setRoleScalar(java.lang.String role)
Role of user responsible for this entry.
Suggested roles are "local_contact",
"principal_investigator", and "proposer"
- Parameters:
role
- the role
-
getAffiliation
IDataset getAffiliation()
Affiliation of user
- Returns:
- the value.
-
setAffiliation
DataNode setAffiliation(IDataset affiliation)
Affiliation of user
- Parameters:
affiliation
- the affiliation
-
getAffiliationScalar
java.lang.String getAffiliationScalar()
Affiliation of user
- Returns:
- the value.
-
setAffiliationScalar
DataNode setAffiliationScalar(java.lang.String affiliation)
Affiliation of user
- Parameters:
affiliation
- the affiliation
-
getAddress
IDataset getAddress()
Address of user
- Returns:
- the value.
-
setAddress
DataNode setAddress(IDataset address)
Address of user
- Parameters:
address
- the address
-
getAddressScalar
java.lang.String getAddressScalar()
Address of user
- Returns:
- the value.
-
setAddressScalar
DataNode setAddressScalar(java.lang.String address)
Address of user
- Parameters:
address
- the address
-
getTelephone_number
IDataset getTelephone_number()
Telephone number of user
- Returns:
- the value.
-
setTelephone_number
DataNode setTelephone_number(IDataset telephone_number)
Telephone number of user
- Parameters:
telephone_number
- the telephone_number
-
getTelephone_numberScalar
java.lang.String getTelephone_numberScalar()
Telephone number of user
- Returns:
- the value.
-
setTelephone_numberScalar
DataNode setTelephone_numberScalar(java.lang.String telephone_number)
Telephone number of user
- Parameters:
telephone_number
- the telephone_number
-
getFax_number
IDataset getFax_number()
Fax number of user
- Returns:
- the value.
-
setFax_number
DataNode setFax_number(IDataset fax_number)
Fax number of user
- Parameters:
fax_number
- the fax_number
-
getFax_numberScalar
java.lang.String getFax_numberScalar()
Fax number of user
- Returns:
- the value.
-
setFax_numberScalar
DataNode setFax_numberScalar(java.lang.String fax_number)
Fax number of user
- Parameters:
fax_number
- the fax_number
-
getEmail
IDataset getEmail()
Email of user
- Returns:
- the value.
-
setEmail
DataNode setEmail(IDataset email)
Email of user
- Parameters:
email
- the email
-
getEmailScalar
java.lang.String getEmailScalar()
Email of user
- Returns:
- the value.
-
setEmailScalar
DataNode setEmailScalar(java.lang.String email)
Email of user
- Parameters:
email
- the email
-
getFacility_user_id
IDataset getFacility_user_id()
facility based unique identifier for this person
e.g. their identification code on the facility
address/contact database
- Returns:
- the value.
-
setFacility_user_id
DataNode setFacility_user_id(IDataset facility_user_id)
facility based unique identifier for this person
e.g. their identification code on the facility
address/contact database
- Parameters:
facility_user_id
- the facility_user_id
-
getFacility_user_idScalar
java.lang.String getFacility_user_idScalar()
facility based unique identifier for this person
e.g. their identification code on the facility
address/contact database
- Returns:
- the value.
-
setFacility_user_idScalar
DataNode setFacility_user_idScalar(java.lang.String facility_user_id)
facility based unique identifier for this person
e.g. their identification code on the facility
address/contact database
- Parameters:
facility_user_id
- the facility_user_id