au.gov.nehta.vendorlibrary.mdm.datatypes
Class XCN.Builder

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.mdm.datatypes.XCN.Builder
Enclosing class:
XCN

public static final class XCN.Builder
extends java.lang.Object

XCN.Builder Build class used to construct and validate an XCN object.


Constructor Summary
XCN.Builder()
          Default constructor.
 
Method Summary
 XCN.Builder assigningAuthority(HD value)
          Set the assigning authority.
 XCN build()
          Build XCN and validate necessary fields.
 XCN.Builder familyName(java.lang.String value)
          Set the family name (not null).
 XCN.Builder givenName(java.lang.String value)
          Set the given name.
 XCN.Builder identifier(java.lang.String value)
          Set the identifier.
 XCN.Builder identifierTypeCode(java.lang.String value)
          Set the identifier type code.
 XCN.Builder middleInitialOrName(java.lang.String value)
          Set the middle initial/name.
 XCN.Builder prefix(java.lang.String value)
          Set the prefix.
 XCN.Builder suffix(java.lang.String value)
          Set the suffix.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XCN.Builder

public XCN.Builder()
Default constructor.

Method Detail

identifier

public XCN.Builder identifier(java.lang.String value)
Set the identifier.

Parameters:
value - Identifier (not null).
Returns:
XCN.Builder

familyName

public XCN.Builder familyName(java.lang.String value)
Set the family name (not null).

Parameters:
value - Family name.
Returns:
XCN.Builder

givenName

public XCN.Builder givenName(java.lang.String value)
Set the given name.

Parameters:
value - Given name (not null).
Returns:
XCN.Builder

middleInitialOrName

public XCN.Builder middleInitialOrName(java.lang.String value)
Set the middle initial/name.

Parameters:
value - Middle initial/name (not null).
Returns:
XCN.Builder

suffix

public XCN.Builder suffix(java.lang.String value)
Set the suffix.

Parameters:
value - Suffix (not null).
Returns:
XCN.Builder

prefix

public XCN.Builder prefix(java.lang.String value)
Set the prefix.

Parameters:
value - Prefix (not null).
Returns:
XCN.Builder

assigningAuthority

public XCN.Builder assigningAuthority(HD value)
Set the assigning authority.

Parameters:
value - Assigning authority (not null).
Returns:
XCN.Builder

identifierTypeCode

public XCN.Builder identifierTypeCode(java.lang.String value)
Set the identifier type code.

Parameters:
value - Identifier type code (not null).
Returns:
XCN.Builder

build

public XCN build()
          throws MDMValidationException
Build XCN and validate necessary fields.

Returns:
XCN
Throws:
MDMValidationException - Thrown when validation fails.