nxopen.pdm

Interface AlternateIdManager

All Superinterfaces:

Remote, TransientObject

public interface AlternateIdManager
extends TransientObject

This class is responsible for setting and getting NX Manager database attribute.
Use PDM.PartBuilder#newAlternateIdManager to get the instance of this class.

Created in NX4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AlternateIdManager.AlternateIdsData Contains alternate Ids data
static class	AlternateIdManager.AssignAlternateIdData This class holds the data returned from assignAlternateId()
static class	AlternateIdManager.AssignAlternateRevData Contains alternate Revision Id data

Method Summary

Modifier and Type	Method and Description
AlternateIdManager.AssignAlternateIdData	assignAlternateId() This method generates alternate item and revision IDs and sets these generated values on this manager class.
AlternateIdManager.AlternateIdsData	assignAlternateIds(String context, String idType) Generates the alternate ID information by calling assignAlternateIds(java.lang.String, java.lang.String) .
String	assignAlternateRevId() This method generates an alternate rev ID and sets this generated value on this manager class.
AlternateIdManager.AssignAlternateRevData	assignAlternateRevision() Generates the alternate Revision ID information.
void	createAlternateIdInformation() Adds the alternate ID information set by calling setAlternateIdInformation(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) and the various "assign" and "set" methods.
String[]	getAllContexts() Gets a list of all the available contexts.
String[]	getAllIdTypes(String context) Gets a list of all the available ID types for a given context.
String	getAlternateDescription() Gets the value of a alternate name as it is currently set on this manager class.
boolean	getAlternateIdAsDefaultIndentifier() Gets (as it is currently set on this manager class) whether the alternate ID information should be the default indentifier.
String	getAlternateItemId() Gets the value of a alternate ID as it is currently set on this manager class.
String	getAlternateName() Gets the value of a alternate name as it is currently set on this manager class.
String	getAlternateRevId() Gets the value of a alternate rev ID as it is currently set on this manager class.
String	getContext() Gets the value of a context as it is currently set on this manager class.
String	getIdType() Gets the value of a ID type as it is currently set on this manager class.
void	setAlternateDescription(String alternateDescription) Sets the value of the alternate description.
void	setAlternateIdAsDefaultIndentifier(boolean alternateIdAsDefaultIndentifier) Sets whether the alternate ID information should be the default indentifier.
void	setAlternateIdInformation(String context, String idType, String alternateItemId, String alternateRevId, String alternateName, String alternateDescription, boolean alternateIdAsDefaultIndentifier) Sets alternate ID information on this manager class. null can be specified for parameters which are set via other set or assign methods on this builder.
void	setAlternateItemId(String alternateItemId) Sets the value of the alternate item ID.
void	setAlternateName(String alternateName) Sets the value of the alternate name.
void	setAlternateRevId(String alternateRevId) Sets the value of the alternate rev ID.
void	setContext(String context) Sets the value of a context.
void	setIdType(String idType) Sets the value of an ID type.

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

setContext

void setContext(String context)
         throws NXException,
                RemoteException

Sets the value of a context.
License requirements: None.

Created in NX4.0.0

Parameters:

context - the new value the context is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

getContext

String getContext()
           throws NXException,
                  RemoteException

Gets the value of a context as it is currently set on this manager class.
License requirements: None.

Created in NX4.0.0

Returns:

the current value of the context on this manager

Throws:

NXException

RemoteException

getAllContexts

String[] getAllContexts()
                 throws NXException,
                        RemoteException

Gets a list of all the available contexts.
License requirements: None.

Created in NX4.0.0

Returns:

list of contexts

Throws:

NXException

RemoteException

setIdType

void setIdType(String idType)
        throws NXException,
               RemoteException

Sets the value of an ID type.
License requirements: None.

Created in NX4.0.0

Parameters:

idType - the new value the ID type is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

getIdType

String getIdType()
          throws NXException,
                 RemoteException

Gets the value of a ID type as it is currently set on this manager class.
License requirements: None.

Created in NX4.0.0

Returns:

the current value of the ID type on this manager

Throws:

NXException

RemoteException

getAllIdTypes

String[] getAllIdTypes(String context)
                throws NXException,
                       RemoteException

Gets a list of all the available ID types for a given context.
License requirements: None.

Created in NX4.0.0

Parameters:

context - the context
NOTE: The full Unicode character set is not supported for this parameter.

Returns:

list of ID types

Throws:

NXException

RemoteException

setAlternateItemId

void setAlternateItemId(String alternateItemId)
                 throws NXException,
                        RemoteException

Sets the value of the alternate item ID.
License requirements: None.

Created in NX4.0.0

Parameters:

alternateItemId - the new value the alternate item ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

assignAlternateId

AlternateIdManager.AssignAlternateIdData assignAlternateId()
                                                    throws NXException,
                                                           RemoteException

This method generates alternate item and revision IDs and sets these generated values on this manager class. Note that the ID context and type must be set on the builder in order for this assign operation to be successful.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

getAlternateItemId

String getAlternateItemId()
                   throws NXException,
                          RemoteException

Gets the value of a alternate ID as it is currently set on this manager class.
License requirements: None.

Created in NX4.0.0

Returns:

the current value of the alternate item ID on this manager

Throws:

NXException

RemoteException

setAlternateRevId

void setAlternateRevId(String alternateRevId)
                throws NXException,
                       RemoteException

Sets the value of the alternate rev ID.
License requirements: None.

Created in NX4.0.0

Parameters:

alternateRevId - the new value the alternate rev ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

assignAlternateRevId

String assignAlternateRevId()
                     throws NXException,
                            RemoteException

This method generates an alternate rev ID and sets this generated value on this manager class. Note that the ID context and type must be set on the builder in order for this assign operation to be successful.
License requirements: None.

Created in NX4.0.0

Returns:

the newly generated alternate rev ID value that was set on this manager

Throws:

NXException

RemoteException

getAlternateRevId

String getAlternateRevId()
                  throws NXException,
                         RemoteException

Gets the value of a alternate rev ID as it is currently set on this manager class.
License requirements: None.

Created in NX4.0.0

Returns:

the current value of the alternate rev ID on this manager

Throws:

NXException

RemoteException

setAlternateName

void setAlternateName(String alternateName)
               throws NXException,
                      RemoteException

Sets the value of the alternate name.
License requirements: None.

Created in NX4.0.0

Parameters:

alternateName - the new value the alternate name is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

getAlternateName

String getAlternateName()
                 throws NXException,
                        RemoteException

Gets the value of a alternate name as it is currently set on this manager class.
License requirements: None.

Created in NX4.0.0

Returns:

the current value of the alternate name on this manager

Throws:

NXException

RemoteException

setAlternateDescription

void setAlternateDescription(String alternateDescription)
                      throws NXException,
                             RemoteException

Sets the value of the alternate description.
License requirements: None.

Created in NX4.0.0

Parameters:

alternateDescription - the new value the alternate description is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

getAlternateDescription

String getAlternateDescription()
                        throws NXException,
                               RemoteException

Gets the value of a alternate name as it is currently set on this manager class.
License requirements: None.

Created in NX4.0.0

Returns:

the current value of the alternate description on this manager

Throws:

NXException

RemoteException

setAlternateIdAsDefaultIndentifier

void setAlternateIdAsDefaultIndentifier(boolean alternateIdAsDefaultIndentifier)
                                 throws NXException,
                                        RemoteException

Sets whether the alternate ID information should be the default indentifier.
License requirements: None.

Created in NX4.0.0

Parameters:

alternateIdAsDefaultIndentifier - the new value the option is to be set to

Throws:

NXException

RemoteException

getAlternateIdAsDefaultIndentifier

boolean getAlternateIdAsDefaultIndentifier()
                                    throws NXException,
                                           RemoteException

Gets (as it is currently set on this manager class) whether the alternate ID information should be the default indentifier.
License requirements: None.

Created in NX4.0.0

Returns:

the current value of option on this manager

Throws:

NXException

RemoteException

setAlternateIdInformation

void setAlternateIdInformation(String context,
                               String idType,
                               String alternateItemId,
                               String alternateRevId,
                               String alternateName,
                               String alternateDescription,
                               boolean alternateIdAsDefaultIndentifier)
                        throws NXException,
                               RemoteException

Sets alternate ID information on this manager class. null can be specified for parameters which are set via other set or assign methods on this builder.
License requirements: None.

Created in NX4.0.0

Parameters:

context - the new value the context is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

idType - the new value the ID type is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

alternateItemId - the new value the alternate item ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

alternateRevId - the new value the alternate rev ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

alternateName - the new value the alternate name is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

alternateDescription - the new value the alternate description is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

alternateIdAsDefaultIndentifier - the new value the option is to be set to

Throws:

NXException

RemoteException

createAlternateIdInformation

void createAlternateIdInformation()
                           throws NXException,
                                  RemoteException

Adds the alternate ID information set by calling setAlternateIdInformation(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) and the various "assign" and "set" methods. The context, ID type, alternate ID, alternate revision ID, and the alternate name must all be set before calling this method.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

assignAlternateIds

AlternateIdManager.AlternateIdsData assignAlternateIds(String context,
                                                       String idType)
                                                throws NXException,
                                                       RemoteException

Generates the alternate ID information by calling assignAlternateIds(java.lang.String, java.lang.String) . Returns pointer to PDM.Altids.AlternateIdsData object. Sets Alternate Name,Alternate Id,Alternate Revision ,Alternate Description, flag for alternate Id modifiable and flag for revision modifiable into Alternate Manager object.
License requirements: None.

Created in NX5.0.0

Parameters:

context - the context
NOTE: The full Unicode character set is not supported for this parameter.

idType - the Id type
NOTE: The full Unicode character set is not supported for this parameter.

Returns:

Contains alternate Ids data

Throws:

NXException

RemoteException

assignAlternateRevision

AlternateIdManager.AssignAlternateRevData assignAlternateRevision()
                                                           throws NXException,
                                                                  RemoteException

Generates the alternate Revision ID information. Sets Alternate Revision and flag for revision modifiable into Alternate Manager object.
License requirements: None.

Created in NX5.0.0

Returns:

Contains alternate Revision Id data

Throws:

NXException

RemoteException