public class Organisation extends Common<Organisation>
Sub-Elements are
Address
, Email
, RelatedOrganisation
, TelephoneFax
Example:
<Organisation cls="U"> <Serial cls="U">DEU:AF:OR:123</Serial> <EntryDateTime cls="U">2011-12-12T00:00:00Z</EntryDateTime> <Name cls="U">LUFTWAFFE</Name> <Address> <CityArea cls="U">Berlin</CityArea> <Country cls="U">DEU</Country> </Address> </Organisation>
approvedBy, approvedDateTime, caseNum, cls, description, entryBy, entryByRole, entryDateTime, extReferenceRef, extReferences, idref, lastChangeBy, lastChangeByRole, lastChangeDateTime, lastObservedBy, lastReviewBy, lastReviewByRole, lastReviewDate, legacyReleasability, modAllowedBy, modAllowedByRole, observedFirstDateTime, observedLastDateTime, owner, ownerRole, quality, recommendedValue, redacted, releasability, remarkRef, remarks, securityClass, serial, state
Constructor and Description |
---|
Organisation()
No arg constructor.
|
Modifier and Type | Method and Description |
---|---|
Set<Address> |
getAddress()
Get the Address
|
S100 |
getAlternateName()
Get an alternate name or nickname for the organisation..
|
D |
getEffectiveDate()
Get the date by which the dataset is to be operational or effective..
|
Set<EMail> |
getEMail()
Get the Email
|
D |
getExpirationDate()
Get the date at which the dataset will expire.
|
S100 |
getName()
Get an alternate name or nickname for the organisation..
|
Set<RelatedOrganisation> |
getRelatedOrganisation()
Get the RelatedOrganisation
|
D |
getReviewDate()
Get the date by which the dataset is to be reviewed.
|
Set<Role> |
getRole()
Get the RoleRef
|
Set<Serial> |
getRoleRef()
Deprecated.
SSRF references are managed automatically. Use
getRole() instead. |
Set<TelephoneFax> |
getTelephoneFax()
Get the TelephoneFax
|
TString |
getType()
Get the type of relationship..
|
S20 |
getUIC()
Get an organisational identifier that may be used to uniquely identify an
organisation in operational planning systems and other non-spectrum
information systems..
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetAddress()
Determine if the Address is configured.
|
boolean |
isSetAlternateName()
Determine if the AlternateName is configured.
|
boolean |
isSetEffectiveDate()
Determine if the EffectiveDate is configured.
|
boolean |
isSetEMail()
Determine if the EMail is configured.
|
boolean |
isSetExpirationDate()
Determine if the ExpirationDate is configured.
|
boolean |
isSetName()
Determine if the Name is configured.
|
boolean |
isSetRelatedOrganisation()
Determine if the RelatedOrganisation is configured.
|
boolean |
isSetReviewDate()
Determine if the ReviewDate is configured.
|
boolean |
isSetRole()
Determine if the role field is configured.
|
boolean |
isSetRoleRef()
Determine if the RoleRef is configured.
|
boolean |
isSetTelephoneFax()
Determine if the TelephoneFax is configured.
|
boolean |
isSetType()
Determine if the Type is configured.
|
boolean |
isSetUIC()
Determine if the UIC is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this Organisation record after
loading from XML.
|
void |
prepare()
Update the SSRF data type references in this Organisation record.
|
void |
setAlternateName(S100 value)
Set an alternate name or nickname for the organisation..
|
void |
setEffectiveDate(D value)
Set the date by which the dataset is to be operational or effective..
|
void |
setExpirationDate(D value)
Set the date at which the dataset will expire.
|
void |
setName(S100 value)
Set an alternate name or nickname for the organisation..
|
void |
setReviewDate(D value)
Set the date by which the dataset is to be reviewed.
|
void |
setType(TString value)
Set the type of relationship..
|
void |
setUIC(S20 value)
Set an organisational identifier that may be used to uniquely identify an
organisation in operational planning systems and other non-spectrum
information systems..
|
String |
toString()
Get a string representation of this Organisation instance configuration.
|
void |
unsetAddress()
Clear the Address field.
|
void |
unsetEMail()
Clear the EMail field.
|
void |
unsetRelatedOrganisation()
Clear the RelatedOrganisation field.
|
void |
unsetRoleRef()
Clear the RoleRef field.
|
void |
unsetTelephoneFax()
Clear the TelephoneFax field.
|
Organisation |
withAddress(Address... values)
Set the Address
|
Organisation |
withAddress(Collection<Address> values)
Set the Address
|
Organisation |
withAlternateName(String value)
Set an alternate name or nickname for the organisation.
|
Organisation |
withEffectiveDate(Calendar value)
Set the date by which the dataset is to be operational or effective.
|
Organisation |
withEffectiveDate(Date value)
Set the date by which the dataset is to be operational or effective.
|
Organisation |
withEMail(Collection<EMail> values)
Set the Email
|
Organisation |
withEMail(EMail... values)
Set the Email
|
Organisation |
withExpirationDate(Calendar value)
Set the date at which the dataset will expire.
|
Organisation |
withExpirationDate(Date value)
Set the date at which the dataset will expire.
|
Organisation |
withName(String value)
Set an alternate name or nickname for the organisation.
|
Organisation |
withRelatedOrganisation(Collection<RelatedOrganisation> values)
Set the RelatedOrganisation
|
Organisation |
withRelatedOrganisation(RelatedOrganisation... values)
Set the RelatedOrganisation
|
Organisation |
withReviewDate(Calendar value)
Set the date by which the dataset is to be reviewed.
|
Organisation |
withReviewDate(Date value)
Set the date by which the dataset is to be reviewed.
|
Organisation |
withRole(Collection<Role> values)
Set the RoleRef
|
Organisation |
withRole(Role... values)
Set the RoleRef
|
Organisation |
withRoleRef(Collection<Serial> values)
Deprecated.
SSRF references are managed automatically. Use
withRole(Role...) instead. |
Organisation |
withRoleRef(Serial... values)
Deprecated.
SSRF references are managed automatically. Use
withRole(Role...) instead. |
Organisation |
withTelephoneFax(Collection<TelephoneFax> values)
Set the TelephoneFax
|
Organisation |
withTelephoneFax(TelephoneFax... values)
Set the TelephoneFax
|
Organisation |
withType(ListCTO value)
Set the type of relationship.
|
Organisation |
withUIC(String value)
Set an organisational identifier that may be used to uniquely identify an
organisation in operational planning systems and other non-spectrum
information systems.
|
compareTo, equals, getApprovedBy, getApprovedDateTime, getCaseNum, getCls, getDescription, getEntryBy, getEntryByRole, getEntryDateTime, getExtReferenceRef, getExtReferences, getIdref, getLastChangeBy, getLastChangeByRole, getLastChangeDateTime, getLastObservedBy, getLastReviewBy, getLastReviewByRole, getLastReviewDate, getLegacyReleasability, getModAllowedBy, getModAllowedByRole, getObservedFirstDateTime, getObservedLastDateTime, getOwner, getOwnerRole, getQuality, getRecommendedValue, getRedacted, getReleasability, getRemarkRef, getRemarks, getSecurityClass, getSerial, getState, hashCode, isSetApprovedBy, isSetApprovedDateTime, isSetCaseNum, isSetCls, isSetDescription, isSetEntryBy, isSetEntryByRole, isSetEntryDateTime, isSetExtReferenceRef, isSetExtReferences, isSetIdref, isSetLastChangeBy, isSetLastChangeByRole, isSetLastChangeDateTime, isSetLastObservedBy, isSetLastReviewBy, isSetLastReviewByRole, isSetLastReviewDate, isSetLegacyReleasability, isSetModAllowedBy, isSetModAllowedByRole, isSetObservedFirstDateTime, isSetObservedLastDateTime, isSetOwner, isSetOwnerRole, isSetQuality, isSetRecommendedValue, isSetRedacted, isSetReleasability, isSetRemarkRef, isSetRemarks, isSetSecurityClass, isSetSerial, isSetState, setApprovedBy, setApprovedDateTime, setCls, setDescription, setEntryBy, setEntryDateTime, setIdref, setLastChangeBy, setLastChangeDateTime, setLastObservedBy, setLastReviewBy, setLastReviewDate, setLegacyReleasability, setModAllowedBy, setObservedFirstDateTime, setObservedLastDateTime, setOwner, setQuality, setRecommendedValue, setRedacted, setSecurityClass, setSerial, setState, unsetCaseNum, unsetExtReferenceRef, unsetExtReferences, unsetReleasability, unsetRemarkRef, unsetRemarks, withApprovedBy, withApprovedDateTime, withApprovedDateTime, withCaseNum, withCaseNum, withCls, withDescription, withEntryBy, withEntryByRole, withEntryDateTime, withExtReferenceRef, withExtReferenceRef, withExtReferences, withExtReferences, withExtReferences, withIdref, withLastChangeBy, withLastChangeByRole, withLastChangeDateTime, withLastChangeDateTime, withLastObservedBy, withLastReviewBy, withLastReviewByRole, withLastReviewDate, withLastReviewDate, withLegacyReleasability, withModAllowedBy, withModAllowedByRole, withObservedFirstDateTime, withObservedFirstDateTime, withObservedLastDateTime, withObservedLastDateTime, withOwner, withOwnerRole, withQuality, withRecommendedValue, withRedacted, withReleasability, withReleasability, withRemarkRef, withRemarkRef, withRemarkRef, withRemarks, withRemarks, withSecurityClass, withSerial, withState
public Organisation()
public D getEffectiveDate()
D
instancepublic void setEffectiveDate(D value)
value
- a D
instancepublic boolean isSetEffectiveDate()
public D getExpirationDate()
D
instancepublic void setExpirationDate(D value)
value
- a D
instancepublic boolean isSetExpirationDate()
public D getReviewDate()
D
instancepublic void setReviewDate(D value)
value
- a D
instancepublic boolean isSetReviewDate()
public S100 getName()
S100
instancepublic void setName(S100 value)
value
- a S100
instancepublic boolean isSetName()
public S100 getAlternateName()
S100
instancepublic void setAlternateName(S100 value)
value
- a S100
instancepublic boolean isSetAlternateName()
public TString getType()
TString
data typepublic void setType(TString value)
value
- the Type value in a TString
data typepublic boolean isSetType()
If configured this method also inspects the TString
wrapped value.
public S20 getUIC()
S20
instancepublic void setUIC(S20 value)
value
- a S20
instancepublic boolean isSetUIC()
public Set<Address> getAddress()
Complex element Address contains the address of a Contact, Organisation or Role..
Address
instancepublic boolean isSetAddress()
public void unsetAddress()
public Set<TelephoneFax> getTelephoneFax()
Complex element TelephoneFax reflects the telephone and/or telefax number(s) of the Contact, Organisation or Role..
TelephoneFax
instancepublic boolean isSetTelephoneFax()
public void unsetTelephoneFax()
public Set<EMail> getEMail()
Complex element Email contains the email address of a Contact or Role..
EMail
instancepublic boolean isSetEMail()
public void unsetEMail()
@Deprecated public Set<Serial> getRoleRef()
getRole()
instead.Complex element RoleRef contains the serial of a referenced Role..
Serial
instancepublic boolean isSetRoleRef()
public void unsetRoleRef()
public Set<RelatedOrganisation> getRelatedOrganisation()
Complex element RelatedOrganisation identifies an Organisation linked to the current Organisation, the type of relation (reporting, budget, etc) and the relation (parent, child, sibling)..
RelatedOrganisation
instancepublic boolean isSetRelatedOrganisation()
public void unsetRelatedOrganisation()
public Organisation withEffectiveDate(Calendar value)
value
- An instances of type Calendar
.public Organisation withEffectiveDate(Date value)
value
- An instances of type Date
.public Organisation withExpirationDate(Calendar value)
value
- An instances of type Calendar
.public Organisation withExpirationDate(Date value)
value
- An instances of type Date
.public Organisation withReviewDate(Calendar value)
value
- An instances of type Calendar
.public Organisation withReviewDate(Date value)
value
- An instances of type Date
.public Organisation withName(String value)
value
- An instances of type String
.public Organisation withAlternateName(String value)
value
- An instances of type String
.public Organisation withType(ListCTO value)
value
- An instances of type ListCTO
.public Organisation withUIC(String value)
value
- An instances of type String
.public Organisation withAddress(Address... values)
Complex element Address contains the address of a Contact, Organisation or Role.
values
- One or more instances of type Address...
.public Organisation withAddress(Collection<Address> values)
Complex element Address contains the address of a Contact, Organisation or Role.
values
- A collection of Address
instancespublic Organisation withTelephoneFax(TelephoneFax... values)
Complex element TelephoneFax reflects the telephone and/or telefax number(s) of the Contact, Organisation or Role.
values
- One or more instances of type TelephoneFax...
.public Organisation withTelephoneFax(Collection<TelephoneFax> values)
Complex element TelephoneFax reflects the telephone and/or telefax number(s) of the Contact, Organisation or Role.
values
- A collection of TelephoneFax
instancespublic Organisation withEMail(EMail... values)
Complex element Email contains the email address of a Contact or Role.
values
- One or more instances of type EMail...
.public Organisation withEMail(Collection<EMail> values)
Complex element Email contains the email address of a Contact or Role.
values
- A collection of EMail
instances@Deprecated public Organisation withRoleRef(Serial... values)
withRole(Role...)
instead.Complex element RoleRef contains the serial of a referenced Role.
values
- One or more instances of type RoleRef...
.@Deprecated public Organisation withRoleRef(Collection<Serial> values)
withRole(Role...)
instead.Complex element RoleRef contains the serial of a referenced Role.
values
- A collection of Serial
instancespublic Organisation withRelatedOrganisation(RelatedOrganisation... values)
Complex element RelatedOrganisation identifies an Organisation linked to the current Organisation, the type of relation (reporting, budget, etc) and the relation (parent, child, sibling).
values
- One or more instances of type RelatedOrganisation...
.public Organisation withRelatedOrganisation(Collection<RelatedOrganisation> values)
Complex element RelatedOrganisation identifies an Organisation linked to the current Organisation, the type of relation (reporting, budget, etc) and the relation (parent, child, sibling).
values
- A collection of RelatedOrganisation
instancespublic String toString()
toString
in class Common<Organisation>
public boolean isSet()
Organisation
requires
cls
, Serial
, EntryDateTime
.
Note that this method only checks for the presence of required information; this method does not validate the information format.
isSet
in class Common<Organisation>
public Set<Role> getRole()
Complex element RoleRef contains the serial of a referenced Role..
Role
instancepublic boolean isSetRole()
public Organisation withRole(Role... values)
Complex element RoleRef contains the serial of a referenced Role.
values
- An instances of type Role
.public Organisation withRole(Collection<Role> values)
Complex element RoleRef contains the serial of a referenced Role.
values
- An instances of type Role
.public void prepare()
This method builds the exported roleRef
field with values from the
transient role
field. This method should typically be called after
the Organisation is configured and (optionally) before exporting an SSRF
message.
prepare
in class Common<Organisation>
public void postLoad(SSRF root)
This method builds the transient role
with values from the
imported roleRef
field. This method should typically be called
after the Organisation is imported from XML.
postLoad
in class Common<Organisation>
root
- the SSRF root instance.Copyright © 2016 OpenSSRF.org. All rights reserved.