us.gov.dod.standard.ssrf._3_1.assignment

Class AsgnAllotOwner

java.lang.Object

us.gov.dod.standard.ssrf._3_1.assignment.AsgnAllotOwner

public class AsgnAllotOwner
extends Object

AsgnAllotOwner (US) contains the serial of the owning, or originating, organisation.

Element of Assignment

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
AsgnAllotOwner()

Method Summary

Modifier and Type	Method and Description
S18	getDescription() Get the name of an individual or organization related to the frequency assignment..
Organisation	getOwnerOrg() Get the serial of the owning, or originating, organisation.
Serial	getOwnerOrgRef() Deprecated. SSRF references are managed automatically. Use getOwnerOrg() instead.
TString	getOwnerType() Get the relationship of an individual or organization to the frequency assignment..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetDescription() Determine if the Description is configured.
boolean	isSetOwnerOrg() Determine if the ownerOrg field is configured.
boolean	isSetOwnerOrgRef() Determine if the OwnerOrgRef is configured.
boolean	isSetOwnerType() Determine if the OwnerType is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this AsgnAllotOwner record after loading from XML.
void	prepare() Update the SSRF data type references in this AsgnAllotOwner record.
void	setDescription(S18 value) Set the name of an individual or organization related to the frequency assignment..
void	setOwnerOrgRef(Serial value) Deprecated. SSRF references are managed automatically. Use #setOwnerOrg(Organisation) instead.
void	setOwnerType(TString value) Set the relationship of an individual or organization to the frequency assignment..
String	toString() Get a string representation of this AsgnAllotOwner instance configuration.
AsgnAllotOwner	withDescription(String value) Set the name of an individual or organization related to the frequency assignment.
AsgnAllotOwner	withOwnerOrg(Organisation value) Set the serial of the owning, or originating, organisation.
AsgnAllotOwner	withOwnerOrgRef(Serial value) Deprecated. SSRF references are managed automatically. Use withOwnerOrg(Organisation) instead.
AsgnAllotOwner	withOwnerType(ListUOW value) Set the relationship of an individual or organization to the frequency assignment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AsgnAllotOwner

public AsgnAllotOwner()

Method Detail

getDescription

public S18 getDescription()

Get the name of an individual or organization related to the frequency assignment..

Returns:

a S18 instance

Since:

3.1.0

setDescription

public void setDescription(S18 value)

Set the name of an individual or organization related to the frequency assignment..

Parameters:

value - a S18 instance

Since:

3.1.0

isSetDescription

public boolean isSetDescription()

Determine if the Description is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getOwnerType

public TString getOwnerType()

Get the relationship of an individual or organization to the frequency assignment..

Returns:

the OwnerType value in a TString data type

Since:

3.1.0

setOwnerType

public void setOwnerType(TString value)

Set the relationship of an individual or organization to the frequency assignment..

Parameters:

value - the OwnerType value in a TString data type

Since:

3.1.0

isSetOwnerType

public boolean isSetOwnerType()

Determine if the OwnerType is configured.

If configured this method also inspects the TString wrapped value.

Returns:

TRUE if the field is set, FALSE if the field is null

getOwnerOrgRef

@Deprecated
public Serial getOwnerOrgRef()

Deprecated. SSRF references are managed automatically. Use getOwnerOrg() instead.

Get the serial of the owning, or originating, organisation. This definitively identifies the owning agency when there is a possibility that multiple entities are listed in a text string name. This identifier can be unambiguously linked to an internal directory of organizations..

Returns:

a Serial instance

Since:

3.1.0

setOwnerOrgRef

@Deprecated
public void setOwnerOrgRef(Serial value)

Deprecated. SSRF references are managed automatically. Use #setOwnerOrg(Organisation) instead.

Set the serial of the owning, or originating, organisation. This definitively identifies the owning agency when there is a possibility that multiple entities are listed in a text string name. This identifier can be unambiguously linked to an internal directory of organizations..

Parameters:

value - a Serial instance

Since:

3.1.0

isSetOwnerOrgRef

public boolean isSetOwnerOrgRef()

Determine if the OwnerOrgRef is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

withDescription

public AsgnAllotOwner withDescription(String value)

Set the name of an individual or organization related to the frequency assignment.

Parameters:

value - An instances of type String.

Returns:

The current AsgnAllotOwner object instance.

Since:

3.1.0

withOwnerType

public AsgnAllotOwner withOwnerType(ListUOW value)

Set the relationship of an individual or organization to the frequency assignment.

Parameters:

value - An instances of type ListUOW.

Returns:

The current AsgnAllotOwner object instance.

Since:

3.1.0

withOwnerOrgRef

@Deprecated
public AsgnAllotOwner withOwnerOrgRef(Serial value)

Deprecated. SSRF references are managed automatically. Use withOwnerOrg(Organisation) instead.

Set the serial of the owning, or originating, organisation. This definitively identifies the owning agency when there is a possibility that multiple entities are listed in a text string name. This identifier can be unambiguously linked to an internal directory of organizations.

Parameters:

value - An instances of type Serial.

Returns:

The current AsgnAllotOwner object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this AsgnAllotOwner instance configuration.

Overrides:

toString in class Object

Returns:

The current object instance configuration as a non-null String

isSet

public boolean isSet()

Determine if the required fields in this SSRF data type instance are set.

AsgnAllotOwner has no configuration requirements.

Returns:

TRUE

getOwnerOrg

public Organisation getOwnerOrg()

Get the serial of the owning, or originating, organisation. This definitively identifies the owning agency when there is a possibility that multiple entities are listed in a text string name. This identifier can be unambiguously linked to an internal directory of organizations..

Returns:

a Organisation instance

Since:

3.1.0

isSetOwnerOrg

public boolean isSetOwnerOrg()

Determine if the ownerOrg field is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

withOwnerOrg

public AsgnAllotOwner withOwnerOrg(Organisation value)

Set the serial of the owning, or originating, organisation. This definitively identifies the owning agency when there is a possibility that multiple entities are listed in a text string name. This identifier can be unambiguously linked to an internal directory of organizations.

Parameters:

value - An instances of type Organisation.

Returns:

The current AsgnAllotOwner object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this AsgnAllotOwner record.

This method builds the exported ownerOrgRef field with values from the transient ownerOrg field. This method should typically be called after the AsgnAllotOwner is configured and (optionally) before exporting an SSRF message.

Since:

3.1.0

postLoad

public void postLoad(SSRF root)

Update the SSRF data type references in this AsgnAllotOwner record after loading from XML.

This method builds the transient ownerOrg with values from the imported ownerOrgRef field. This method should typically be called after the AsgnAllotOwner is imported from XML. * @param root the SSRF root instance.

Since:

3.1.0