us.gov.dod.standard.ssrf._3_1.ssrequest

Class DiagramEndpoint

java.lang.Object

us.gov.dod.standard.ssrf._3_1.ssrequest.DiagramEndpoint

public class DiagramEndpoint
extends Object

DiagramEndpoint defines an instance of an icon on the diagram.

Element of SSRequest

Sub-Element is EndpointLocation

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
DiagramEndpoint()

Method Summary

Modifier and Type	Method and Description
S100	getDescription() Get a human-readable description of a diagram endpoint..
S20	getEndpointID() Get an identifier for each icon on the diagram.
Set<EndpointLocation>	getEndpointLocation() Get the EndpointLocation
US_Twips	getIconPosLeft() Get the X coordinate of the icon in twips.
US_Twips	getIconPosTop() Get the Y coordinate of the icon in twips." to read, "In Data Item IconPosTop, enter the Y coordinate of the icon in twips.
TString	getIconType() Get the type of icon for the diagram endpoint..
S15	getName() Get a human-readable name of a diagram endpoint, or Station..
TString	getPointToMultiPoint() Get "Yes" if the diagram endpoint participates in point-to-multipoint links.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetDescription() Determine if the Description is configured.
boolean	isSetEndpointID() Determine if the EndpointID is configured.
boolean	isSetEndpointLocation() Determine if the EndpointLocation is configured.
boolean	isSetIconPosLeft() Determine if the IconPosLeft is configured.
boolean	isSetIconPosTop() Determine if the IconPosTop is configured.
boolean	isSetIconType() Determine if the IconType is configured.
boolean	isSetName() Determine if the Name is configured.
boolean	isSetPointToMultiPoint() Determine if the PointToMultiPoint is configured.
void	setDescription(S100 value) Set a human-readable description of a diagram endpoint..
void	setEndpointID(S20 value) Set an identifier for each icon on the diagram.
void	setIconPosLeft(US_Twips value) Set the X coordinate of the icon in twips.
void	setIconPosTop(US_Twips value) Set the Y coordinate of the icon in twips." to read, "In Data Item IconPosTop, enter the Y coordinate of the icon in twips.
void	setIconType(TString value) Set the type of icon for the diagram endpoint..
void	setName(S15 value) Set a human-readable name of a diagram endpoint, or Station..
void	setPointToMultiPoint(TString value) Set "Yes" if the diagram endpoint participates in point-to-multipoint links.
String	toString() Get a string representation of this DiagramEndpoint instance configuration.
void	unsetEndpointLocation() Clear the EndpointLocation field.
DiagramEndpoint	withDescription(String value) Set a human-readable description of a diagram endpoint.
DiagramEndpoint	withEndpointID(String value) Set an identifier for each icon on the diagram.
DiagramEndpoint	withEndpointLocation(Collection<EndpointLocation> values) Set the EndpointLocation
DiagramEndpoint	withEndpointLocation(EndpointLocation... values) Set the EndpointLocation
DiagramEndpoint	withIconPosLeft(Integer value) Set the X coordinate of the icon in twips.
DiagramEndpoint	withIconPosTop(Integer value) Set the Y coordinate of the icon in twips." to read, "In Data Item IconPosTop, enter the Y coordinate of the icon in twips.
DiagramEndpoint	withIconType(ListCIC value) Set the type of icon for the diagram endpoint.
DiagramEndpoint	withName(String value) Set a human-readable name of a diagram endpoint, or Station.
DiagramEndpoint	withPointToMultiPoint(ListCBO value) Set "Yes" if the diagram endpoint participates in point-to-multipoint links.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagramEndpoint

public DiagramEndpoint()

Method Detail

getIconType

public TString getIconType()

Get the type of icon for the diagram endpoint..

Returns:

the IconType value in a TString data type

Since:

3.1.0

setIconType

public void setIconType(TString value)

Set the type of icon for the diagram endpoint..

Parameters:

value - the IconType value in a TString data type

Since:

3.1.0

isSetIconType

public boolean isSetIconType()

Determine if the IconType 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

getEndpointID

public S20 getEndpointID()

Get an identifier for each icon on the diagram. Within a diagram, all EndPointIDs must be unique..

Returns:

a S20 instance

Since:

3.1.0

setEndpointID

public void setEndpointID(S20 value)

Set an identifier for each icon on the diagram. Within a diagram, all EndPointIDs must be unique..

Parameters:

value - a S20 instance

Since:

3.1.0

isSetEndpointID

public boolean isSetEndpointID()

Determine if the EndpointID is configured.

Returns:

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

getDescription

public S100 getDescription()

Get a human-readable description of a diagram endpoint..

Returns:

a S100 instance

Since:

3.1.0

setDescription

public void setDescription(S100 value)

Set a human-readable description of a diagram endpoint..

Parameters:

value - a S100 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

getName

public S15 getName()

Get a human-readable name of a diagram endpoint, or Station..

Returns:

a S15 instance

Since:

3.1.0

setName

public void setName(S15 value)

Set a human-readable name of a diagram endpoint, or Station..

Parameters:

value - a S15 instance

Since:

3.1.0

isSetName

public boolean isSetName()

Determine if the Name is configured.

Returns:

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

getIconPosLeft

public US_Twips getIconPosLeft()

Get the X coordinate of the icon in twips. Twips are screen-independent units to ensure that the proportion of screen elements is the same on all display systems. A twip is defined as being 1/1440 of an inch, or 17.639µm..

Returns:

a US_Twips instance

Since:

3.1.0

setIconPosLeft

public void setIconPosLeft(US_Twips value)

Set the X coordinate of the icon in twips. Twips are screen-independent units to ensure that the proportion of screen elements is the same on all display systems. A twip is defined as being 1/1440 of an inch, or 17.639µm..

Parameters:

value - a US_Twips instance

Since:

3.1.0

isSetIconPosLeft

public boolean isSetIconPosLeft()

Determine if the IconPosLeft is configured.

Returns:

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

getIconPosTop

public US_Twips getIconPosTop()

Get the Y coordinate of the icon in twips." to read, "In Data Item IconPosTop, enter the Y coordinate of the icon in twips. Twips are screen-independent units to ensure that the proportion of screen elements is the same on all display systems. A twip is defined as being 1/1440 of an inch, or 17.639µm..

Returns:

a US_Twips instance

Since:

3.1.0

setIconPosTop

public void setIconPosTop(US_Twips value)

Set the Y coordinate of the icon in twips." to read, "In Data Item IconPosTop, enter the Y coordinate of the icon in twips. Twips are screen-independent units to ensure that the proportion of screen elements is the same on all display systems. A twip is defined as being 1/1440 of an inch, or 17.639µm..

Parameters:

value - a US_Twips instance

Since:

3.1.0

isSetIconPosTop

public boolean isSetIconPosTop()

Determine if the IconPosTop is configured.

Returns:

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

getPointToMultiPoint

public TString getPointToMultiPoint()

Get "Yes" if the diagram endpoint participates in point-to-multipoint links. enter "No" if it participates in point-to-point links. Note for the USA: Required when operating between 932 and 935 MHz or 941 and 944 MHz..

Returns:

the PointToMultiPoint value in a TString data type

Since:

3.1.0

setPointToMultiPoint

public void setPointToMultiPoint(TString value)

Set "Yes" if the diagram endpoint participates in point-to-multipoint links. enter "No" if it participates in point-to-point links. Note for the USA: Required when operating between 932 and 935 MHz or 941 and 944 MHz..

Parameters:

value - the PointToMultiPoint value in a TString data type

Since:

3.1.0

isSetPointToMultiPoint

public boolean isSetPointToMultiPoint()

Determine if the PointToMultiPoint 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

getEndpointLocation

public Set<EndpointLocation> getEndpointLocation()

Get the EndpointLocation

Complex element EndpointLocation defines locations where the diagram endpoint is allowed or forbidden from use..

Returns:

a EndpointLocation instance

Since:

3.1.0

isSetEndpointLocation

public boolean isSetEndpointLocation()

Determine if the EndpointLocation is configured.

Returns:

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

unsetEndpointLocation

public void unsetEndpointLocation()

Clear the EndpointLocation field. This sets the field to null.

withIconType

public DiagramEndpoint withIconType(ListCIC value)

Set the type of icon for the diagram endpoint.

Parameters:

value - An instances of type ListCIC.

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withEndpointID

public DiagramEndpoint withEndpointID(String value)

Set an identifier for each icon on the diagram. Within a diagram, all EndPointIDs must be unique.

Parameters:

value - An instances of type String.

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withDescription

public DiagramEndpoint withDescription(String value)

Set a human-readable description of a diagram endpoint.

Parameters:

value - An instances of type String.

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withName

public DiagramEndpoint withName(String value)

Set a human-readable name of a diagram endpoint, or Station.

Parameters:

value - An instances of type String.

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withIconPosLeft

public DiagramEndpoint withIconPosLeft(Integer value)

Set the X coordinate of the icon in twips. Twips are screen-independent units to ensure that the proportion of screen elements is the same on all display systems. A twip is defined as being 1/1440 of an inch, or 17.639µm.

Parameters:

value - An instances of type Integer.

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withIconPosTop

public DiagramEndpoint withIconPosTop(Integer value)

Set the Y coordinate of the icon in twips." to read, "In Data Item IconPosTop, enter the Y coordinate of the icon in twips. Twips are screen-independent units to ensure that the proportion of screen elements is the same on all display systems. A twip is defined as being 1/1440 of an inch, or 17.639µm.

Parameters:

value - An instances of type Integer.

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withPointToMultiPoint

public DiagramEndpoint withPointToMultiPoint(ListCBO value)

Set "Yes" if the diagram endpoint participates in point-to-multipoint links. enter "No" if it participates in point-to-point links. Note for the USA: Required when operating between 932 and 935 MHz or 941 and 944 MHz.

Parameters:

value - An instances of type ListCBO.

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withEndpointLocation

public DiagramEndpoint withEndpointLocation(EndpointLocation... values)

Set the EndpointLocation

Complex element EndpointLocation defines locations where the diagram endpoint is allowed or forbidden from use.

Parameters:

values - One or more instances of type EndpointLocation....

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

withEndpointLocation

public DiagramEndpoint withEndpointLocation(Collection<EndpointLocation> values)

Set the EndpointLocation

Complex element EndpointLocation defines locations where the diagram endpoint is allowed or forbidden from use.

Parameters:

values - A collection of EndpointLocation instances

Returns:

The current DiagramEndpoint object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this DiagramEndpoint 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.

DiagramEndpoint requires EndpointID.

Note that this method only checks for the presence of required information; this method does not validate the information format.

Returns:

TRUE if required fields are set, otherwise FALSE