us.gov.dod.standard.ssrf._3_1

Class ChannelPlan

java.lang.Object

us.gov.dod.standard.ssrf._3_1.Common<ChannelPlan>

us.gov.dod.standard.ssrf._3_1.ChannelPlan

All Implemented Interfaces:

Comparable<ChannelPlan>

public class ChannelPlan
extends Common<ChannelPlan>

ChannelPlan describes the plan for the channel set.

Sub-Element is Channel

Example:

 <ChannelPlan>
   <Channel>
     <Name cls="U">Channel Plan One</Name>
     <User  cls="U">Channel Master</User >
     <ChannelFreq cls="U">200</ChannelFreq>
   </Channel>
   <Channel>
     <Name cls="U">Channel Plan Seven</Name>
     <User  cls="U">Channel Meister</User >
     <ChannelFreq cls="U">400</ChannelFreq>
   </Channel>
 </ChannelPlan>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Field Summary

Fields inherited from class us.gov.dod.standard.ssrf._3_1.Common

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 Summary

Constructors

Constructor and Description
ChannelPlan() No arg constructor.

Method Summary

Modifier and Type	Method and Description
Set<Channel>	getChannel() Get the serial of the referenced ChannelPlan..
S100	getName() Get the name of this channel plan (e.g., "Plan for Wireless Microphones in the Band 162-174 MHz")..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetChannel() Determine if the Channel is configured.
boolean	isSetName() Determine if the Name is configured.
void	setName(S100 value) Set the name of this channel plan (e.g., "Plan for Wireless Microphones in the Band 162-174 MHz")..
String	toString() Get a string representation of this ChannelPlan instance configuration.
void	unsetChannel() Clear the Channel field.
ChannelPlan	withChannel(Channel... values) Set the serial of the referenced ChannelPlan.
ChannelPlan	withChannel(Collection<Channel> values) Set the serial of the referenced ChannelPlan.
ChannelPlan	withName(String value) Set the name of this channel plan (e.g., "Plan for Wireless Microphones in the Band 162-174 MHz").

Methods inherited from class us.gov.dod.standard.ssrf._3_1.Common

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, postLoad, prepare, 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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelPlan

public ChannelPlan()

No arg constructor. Initializes the Common required fields.

Method Detail

getName

public S100 getName()

Get the name of this channel plan (e.g., "Plan for Wireless Microphones in the Band 162-174 MHz")..

Returns:

a S100 instance

Since:

3.1.0

setName

public void setName(S100 value)

Set the name of this channel plan (e.g., "Plan for Wireless Microphones in the Band 162-174 MHz")..

Parameters:

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

getChannel

public Set<Channel> getChannel()

Get the serial of the referenced ChannelPlan..

Returns:

a Channel instance

Since:

3.1.0

isSetChannel

public boolean isSetChannel()

Determine if the Channel is configured.

Returns:

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

unsetChannel

public void unsetChannel()

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

withName

public ChannelPlan withName(String value)

Set the name of this channel plan (e.g., "Plan for Wireless Microphones in the Band 162-174 MHz").

Parameters:

value - An instances of type String.

Returns:

The current ChannelPlan object instance.

Since:

3.1.0

withChannel

public ChannelPlan withChannel(Channel... values)

Set the serial of the referenced ChannelPlan.

Parameters:

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

Returns:

The current ChannelPlan object instance.

Since:

3.1.0

withChannel

public ChannelPlan withChannel(Collection<Channel> values)

Set the serial of the referenced ChannelPlan.

Parameters:

values - A collection of Channel instances

Returns:

The current ChannelPlan object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this ChannelPlan instance configuration.

Overrides:

toString in class Common<ChannelPlan>

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.

ChannelPlan requires cls, Serial, EntryDateTime and Channel, Name.

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

Overrides:

isSet in class Common<ChannelPlan>

Returns:

TRUE if required fields are set, otherwise FALSE