|
|
The file SYcrbNPT.idl contains the following interfaces:
SYcrbNPT::ChangeRequest SYcrbNPT::ChangeRequestFactory SYcrbNPT::Connection SYcrbNPT::ConnectionFactory SYcrbNPT::EndPoint SYcrbNPT::EndPointFactory SYcrbNPT::EventSource SYcrbNPT::EventSourceFactory SYcrbNPT::Lister SYcrbNPT::LogFileServer SYcrbNPT::Managed SYcrbNPT::ManagedComponent SYcrbNPT::ManagedComponentFactory SYcrbNPT::ManagedComponentLister SYcrbNPT::ManagedFactory SYcrbNPT::MetaDataServer SYcrbNPT::NetworkElement SYcrbNPT::NetworkElementFactory SYcrbNPT::Persistent SYcrbNPT::PersistentFactory SYcrbNPT::Session SYcrbNPT::SessionFactory SYcrbNPT::SiteItemLister SYcrbNPT::UploadRequest SYcrbNPT::UploadRequestFactory
This module provides access to the management functions of the product. This includes the following areas: Session management, Lister interface, and Network Element interface.
Represents the action item.
struct ActionItem
{
string name;
string parm1;
string parm2;
};
name--string that represents the name of the permission (one of CHOOSE, DISPLAY, GETLIST, NEW, REMOVE, SAVE, UNDO, UPLOAD, VIEW, ZOOM).
parm1--string that represents parameter1, which
is only used for a NEW action. This represents the Object ID for the parent object of the object being created. Otherwise, it is an empty string.
parm2--string that represents parameter2. This is not used (empty string).
typedef sequence<ActionItem> ActionItemSeq;
struct AttributeErrorItem
{
AttributeName name;
ErrorNumber number;
ErrorText text;
};
typedef sequence<AttributeErrorItem> AttributeErrorItemSeq;
Represents the attribute item.
typedef string AttributeItem;
typedef sequence<AttributeItem> AttributeItemSeq;
Represents the attribute name.
typedef string AttributeName;
Represents the attribute result item.
typedef string AttributeResultItem;
typedef sequence<AttributeResultItem> AttributeResultItemSeq;
typedef sequence<AttributeResultItemSeq> AttributeResultItemSeqSeq;
Represents the attribute value.
typedef string AttributeValue;
struct AttributeValueAndGuiModeItem
{
AttributeName name;
AttributeValue value;
Mode mode;
string guiMode;
};
typedef sequence<AttributeValueAndGuiModeItem> AttributeValueAndGuiModeItemSeq;
struct AttributeValueAndModeItem
{
AttributeName name;
AttributeValue value;
Mode mode;
};
typedef sequence<AttributeValueAndModeItem> AttributeValueAndModeItemSeq;
struct AttributeValueItem
{
AttributeName name;
AttributeValue value;
};
typedef sequence<AttributeValueItem> AttributeValueItemSeq;
This specifies the category associated with an exception. Normally exceptions are only thrown with one of the failed categories.
enum Category
{
succeeded,
succeededWithStatus,
failedWaitAndRetry,
failedCorrectAndRetry,
failedNoRetry,
fatalFailure
};
typedef sequence<char> charSeq;
Represents the Class ID.
typedef string ClassId;
Represents the database ID.
typedef long DbId;
Represents the error message.
struct ErrorMessage
{
string vendor;
string application;
string pid;
string subsystem;
Severity severity;
Verbosity verbosity;
ObjectId objectId;
ErrorNumber ident;
ErrorText message;
};
vendor--string that represents the vendor of the software that generated the error.
application--string that represents the name of a software application process.
pid--string that represents the UNIX process where the error was generated.
subsystem--string that represents the name of a software subsystem.
severity--Severity that represents the severity.
verbosity--Verbosity that represents the verbosity.
objectId--ObjectId that represents the object ID.
ident--ErrorNumber that represents the error number.
message--ErrorText that represents the text of the error message.
Represents the error message sequence.
typedef sequence<ErrorMessage> ErrorMessageSeq;
Represents the error number.
typedef long ErrorNumber;
Represents the error stack.
struct ErrorStack
{
ErrorNumber status;
Category category;
ErrorMessageSeq errors;
};
status--ErrorNumber that represents the error number.
category--Category that represents the category.
errors--ErrorMessageSeq that represents the errors.
Represents the error text.
typedef string ErrorText;
typedef long EventSourceId;
typedef sequence<EventSourceId> EventSourceIdSeq;
Specifies the mode of an object attribute.
enum Mode
{
UnknownMode,
ReadOnlyMode,
ReadWriteMode,
ProfileReadOnlyMode,
ProfileReadWriteMode,
GuiMode
};
UnknownMode specifies that the mode is unknown.
ReadOnlyMode specifies that the mode is read-only.
ReadWriteMode specifies that the mode is read/write.
ProfileReadOnlyMode specifies that the mode is read-only for the profile.
ProfileReadWriteMode specifies that the mode is read/write for the profile.
GuiMode specifies that the mode is GUI.
struct MVCEvent
{
string eventClass;
string eventType;
ObjectIdSeq modelIds;
string parameters;
};
typedef sequence<MVCEvent> MVCEventSeq;
Represents the Object ID.
typedef string ObjectId;
typedef sequence<ObjectId> ObjectIdSeq;
Specifies the comparison operation in the SYcrbNPT::Lister search criteria.
enum Operation
{
EqualTo,
Like,
CaseLike,
NotEqualTo,
NotLike,
CaseNotLike,
GreaterThan,
GreaterThanOrEqualTo,
LessThan,
LessThanOrEqualTo
};
Specifies the order in which the SYcrbNPT::Lister results can be sorted.
enum Order
{
AscendingOrder,
DescendingOrder
};
struct OrderByItem
{
AttributeName name;
Order order;
};
typedef sequence<OrderByItem> OrderByItemSeq;
Specifies the pending operation returned from the SYcrbNPT::Managed::getPendingOperation method.
enum PendingOperation
{
UnknownPending,
NoPending,
NewPending,
AddPending,
ModifyPending,
DeletePending,
ReloadPending
};
UnknownPending specifies that the pending operation is unknown.
NoPending specifies that there is no pending operation.
NewPending specifies that there is a new pending operation.
AddPending specifies that a pending operation should be added.
ModifyPending specifies that the pending operation should be modified.
DeletePending specifies that the pending operation should be deleted.
ReloadPending specifies that the pending operation should be reloaded.
Specifies the permission associated with an action as returned by SYcrbNPT::Persistent::getPermittedActions and SYcrbNPT::Lister::getPermittedActions.
enum Permission
{
UnknownPermission,
YesPermission,
NoPermission,
NeverPermission
};
UnknownPermission specifies that the permission is unknown.
YesPermission specifies that there is permission for an action.
NoPermission specifies that there is no permission for an action.
NeverPermission specifies that there is never permission for an action.
struct PermissionItem
{
string name;
Permission permission;
string reason;
};
typedef sequence<PermissionItem> PermissionItemSeq;
Represents the Persistent ID.
typedef ObjectId PersistentId;
struct SearchItem
{
AttributeName name;
Operation operation;
AttributeValue value;
};
typedef sequence<SearchItem> SearchItemSeq;
This specifies the severity associated with a given error message in a stack of error messages in an exception.
enum Severity
{
information,
warning,
problem,
error,
fatal
};
typedef sequence<string> stringSeq;
struct SubtypeItem
{
ClassId className;
string description;
};
typedef sequence<SubtypeItem> SubtypeItemSeq;
Represents the unique by item.
typedef string UniqueByItem;
typedef sequence<UniqueByItem> UniqueByItemSeq;
Represents the upload item. This is Equipment Module-specific.
struct UpLoadItem
{
string key;
string value1;
string value2;
};
key--string that represents the key.
value1--string that represents value1.
value2--string that represents value2.
typedef sequence<UpLoadItem> UpLoadItemSeq;
This specifies the verbosity associated with a given error message in a stack of error messages in an exception.
enum Verbosity
{
user,
normal,
enhanced,
detailed
};
const string ADD_PENDING_OPERATION = "0" const long ADD_PENDING_OPERATION_NUM = 0 const string CHECK_ACTION = "CHECK" const string CHOOSE_ACTION = "CHOOSE" const string COMMIT_ACTION = "COMMIT" const string CURRENT_COID_ATTRIBUTE = "current_coid" const string CURRENT_CRNUMBER_ATTRIBUTE = "current_crnumber" const string CURRENT_NO_PENDING_STATUS = "CURRENTNOPENDING" const string CURRENT_VERSION = "0" const long CURRENT_VERSION_NUM = 0 const string CURRENT_WITH_INVALID_PENDING_STATUS = "CURRENTWITHINVALIDPENDING" const string CURRENT_WITH_PENDING_STATUS = "CURRENTWITHPENDING" const string DELETE_PENDING_OPERATION = "2" const long DELETE_PENDING_OPERATION_NUM = 2 const string DISPLAY_ACTION = "DISPLAY" const string GETLIST_ACTION = "GETLIST" const string INVALID_PENDING_STATUS = "INVALID" const string KEYOBJECTID = "KEYOBJECTID" const string MODIFY_PENDING_OPERATION = "1" const long MODIFY_PENDING_OPERATION_NUM = 1 const string NEW_ACTION = "NEW" const string NEW_PENDING_OPERATION = "5" const long NEW_PENDING_OPERATION_NUM = 5 const string NO_PENDING_OPERATION = "4" const long NO_PENDING_OPERATION_NUM = 4 const string PENDING_OPERATION_ATTRIBUTE = "pending_operation" const string PENDING_STATUS = "PENDING" const string PENDING_STATUS_ATTRIBUTE = "pending_status" const string PENDING_VERSION = "1" const long PENDING_VERSION_NUM = 1 const string REJECT_ACTION = "REJECT" const string RELOAD_ACTION = "RELOAD" const string RELOAD_PENDING_OPERATION = "3" const long RELOAD_PENDING_OPERATION_NUM = 3 const string REMOVE_ACTION = "REMOVE" const string REVERT_ACTION = "REVERT" const string SAVE_ACTION = "SAVE" const string SECURITY_DOMAIN = "domain" const string SECURITY_UNSECURED = "-" const string SECURITY_VPN = "vpn" const string SUPERSEDED1_VERSION = "2"
const long SUPERSEDED1_VERSION_NUM = 2 const string SUPERSEDED2_VERSION = "3" const long SUPERSEDED2_VERSION_NUM = 3 const string SY_CHANGEORDERID_COLUMN = "sy_changeorderid" const string SY_COMMITTEDDATE_COLUMN = "sy_committeddate" const string SY_CONFREV_COLUMN = "sy_confrev" const string SY_CREATEDDATE_COLUMN = "sy_createddate" const string SY_MASTEROID_COLUMN = "sy_masteroid" const string SY_MODIFIEDDATE_COLUMN = "sy_modifieddate" const string SY_OBJECTID_COLUMN = "sy_objectid" const string SY_PENDINGOPERATION_COLUMN = "sy_pendoperation" const string SY_PROFNAME_COLUMN = "sy_profname" const string SY_RETURNOID_COLUMN = "sy_returnoid" const string SY_SEQUENCENUMBER_COLUMN = "sy_sequencenumber" const string SY_SNOOKERSEQNUM_COLUMN = "sy_snookerseqnum" const string SY_SORTORDER_COLUMN = "sy_sort_order" const string SY_VERSION_COLUMN = "sy_version" const string TOMBSTONE_VERSION = "4" const long TOMBSTONE_VERSION_NUM = 4 const string TRANSLATE_ACTION = "TRANSLATE" const string UNDO_ACTION = "UNDO" const string UPLOAD_ACTION = "UPLOAD" const string VIEW_ACTION = "VIEW" const string ZOOM_ACTION = "ZOOM"
exception noSuchEvent
{
};
This is an exception that is thrown when an invalid EventSourceId is passed as a parameter to an EventSourceFactory method.
exception noSuchEventSource
{
};
This is an NPT exception.
exception NptException
{
ErrorStack errorStack;
};
This is an NPT get value exception.
exception NptGetValueException
{
ErrorStack errorStack;
AttributeValue returnedValue;
};
This is an NPT save exception.
exception NptSaveException
{
ErrorStack errorStack;
AttributeErrorItemSeq failedAttributes;
};
Internal use only.
Internal use only.
void abort() raises(NptException);
Internal use only.
void approve() raises(NptException);
Internal use only.
void check() raises(NptException);
Internal use only.
void close() raises(NptException);
Internal use only.
void commit() raises(NptException);
Internal use only.
void create() raises(NptException);
Internal use only.
void open() raises(NptException);
Internal use only.
void reapprove() raises(NptException);
Internal use only.
void reject() raises(NptException);
Internal use only.
void retry() raises(NptException);
Internal use only.
void schedule() raises(NptException);
Internal use only.
void submitForApproval() raises(NptException);
Internal use only.
void submitForScheduling() raises(NptException);
Internal use only.
Internal use only.
ChangeRequest bindChangeRequest(in PersistentId id)
raises(NptException);
Internal use only.
ChangeRequest createChangeRequest(in ClassId nptClassName)
raises(NptException);
Internal use only.
Internal use only.
Internal use only.
Connection bindConnection(in PersistentId id)
raises(NptException);
Internal use only.
Connection createConnection(in ClassId nptClassName)
raises(NptException);
Internal use only.
Internal use only.
Internal use only.
EndPoint bindEndPoint(in PersistentId id)
raises(NptException);
Internal use only.
EndPoint createEndPoint(in ClassId nptClassName)
raises(NptException);
This interface provides access to the methods for getting, enabling, and disabling events.
Disables a type of event that was previously enabled.
void disableEvent(in string eventClass, in string eventType, in ObjectIdSeq modelIds, in FilterMode filter)
raises(noSuchEvent,NptException);
eventClass--in string represents the class of the event.
eventType--in string represents the type of the event.
modelIds--in ObjectIdSeq represents a list of the model for which the event was generated.
filter--in FilterMode represents the filter mode used when enabling and disabling events.
noSuchEvent NptException
Selects the types of events forwarded to the even channel. By default, no events are forwarded. This method can be called more than once and the results are cumulative.
void enableEvent(in string eventClass, in string eventType, in ObjectIdSeq modelIds, in FilterMode filter)
raises(NptException);
eventClass--in string represents the class of the event.
eventType--in string represents the type of the event.
modelIds--in ObjectIdSeq represents a list of the model for which the event was generated.
filter--in FilterMode represents the filter mode used when enabling and disabling events.
NptException
Gets the CORBA event channel associated with this EventSource.
CosEventChannelAdmin::EventChannel getEventChannel();
CosEventChannelAdmin::EventChannel
Gets the EventSourceId of this EventSource.
EventSourceId getEventSourceId();
EventSourceId
This specifies the filter mode used when enabling and disabling events.
enum FilterMode
{
intraSession,
interSession,
allSession
};
intraSession represents Events generated inside the same session that you are running.
This interface provides access to the methods for creating, destroying, and getting EventSources.
Creates a new EventSource object. An EventSource object is an object within the Server that forwards internal database change events onto a CORBA Event Services channel. The Client application is responsible for creating (and deleting) the event channel. The event channel is passed as an input parameter to this method. A reference to the EventSource object created is returned as well as the assigned EventSource id.
EventSource createEventSource(in CosEventChannelAdmin::EventChannel channel, out EventSourceId id)
raises(NptException);
channel--in CosEventChannelAdmin::EventChannel represents the event channel.
id--out EventSourceId represents the ID of the event source.
EventSource
NptException
Deletes an EventSource object. The object to be deleted is identified by its EventSourceId.
void destroyEventSource(in EventSourceId id)
raises(noSuchEventSource);
id--in EventSourceId represents the ID of the event source.
noSuchEventSource
Returns the EventSourceIds of all of the EventSources in this session.
EventSourceIdSeq getAllEventSources();
EventSourceIdSeq
Returns a reference to the EventSource objects given its EventSourceId.
EventSource getEventSource(in EventSourceId id)
raises(noSuchEventSource);
id--in EventSourceId represents the ID of the event source.
noSuchEventSource
This interface provides access to the methods for listing attributes.
Clears the result list of the last getList or getObject. This frees up memory resources on the Server but does not remove the CORBA lister object. The preferred approach is to use the remove operation that removes the CORBA lister object as well as freeing up the memory associated with the query results.
void clearList() raises(NptException);
NptException
This is a generic method interface, behavior is instance specific.
void genericRequest(in string command, inout string parameters)
raises(NptException);
command--in string specifies the command.
parameters--inout string specifies the parameters.
NptException
Provides the user with a mechanism for getting the count of records which matched the search crtieria. Note that this can be called only after calling getList or getFullList.
long getCount() raises(NptException);
NptException
Gets the criteria set in a previous getList.
void getCriteria(out SearchItemSeq searchList, out AttributeItemSeq columnList, out OrderByItemSeq orderByList, out UniqueByItemSeq uniqueByList, out boolean noDeletePending)
raises(NptException);
searchList--out SearchItemSeq representing the search criteria.
columnList--out AttributeItemSeq representing the object attributes to be returned.
orderByList--out OrderByItemSeq specifies which column(s) the results should be sorted by, and whether ascending or descending order is required.
uniqueByList--out UniqueByItemSeq specifies the column(s) used to identify and remove duplicate rows in the results.
noDeletePending--out boolean
NptException
Provides the user with a mechanism for setting the search criteria and performing the database query for records which match the search criteria. Any criteria can be used for the getList operation with the exception of computed attributes and computed relationships. All rows are returned, current and pending even if for another Transaction.
void getFullList(in SearchItemSeq searchList, in AttributeItemSeq columnList, in OrderByItemSeq orderByList, in UniqueByItemSeq uniqueByList)
raises(NptException);
searchList--in SearchItemSeq representing the search criteria.
columnList--in AttributeItemSeq representing the object attributes to be returned.
orderByList--in OrderByItemSeq specifies which column(s) the results should be sorted by, and whether ascending or descending order is required.
uniqueByList--in UniqueByItemSeq specifies the column(s) used to identify and remove duplicate rows in the results.
NptException
Provides the user with a mechanism for getting the objects which matched the search criteria. The following data is returned for each object which matched the search criteria: result columns specified by setCriteria, object ID, pending operation: none, add, modify, delete, reload. Note that this can be called only after calling getList or getFullList.
void getItems(in long fromItem, in long toItem, out AttributeItemSeq names, out AttributeResultItemSeqSeq results)
raises(NptException);
fromItem--in long specifies the index of the first results row to be returned (numbered from 1, not 0).
toItem--in long specifies the index of the last results row to be returned.
names--out AttributeItemSeq specifies the attribute column names for the returned results.
results--out AttributeResultItemSeqSeq specifies the attribute values (first dimension selects the row, second dimension selects the column).
NptException
Provides the user with a mechanism for setting the search criteria and performing the database query for records which match the search criteria. Any criteria can be used for the getList operation with the exception of computed attributes and computed relationships. The database is queried and the results are stored in memory in the Server. Results are subsequently obtained by the Client by calling getItems.
void getList(in SearchItemSeq searchList, in AttributeItemSeq columnList, in OrderByItemSeq orderByList, in UniqueByItemSeq uniqueByList)
raises(NptException);
searchList--in SearchItemSeq representing the search criteria.
columnList--in AttributeItemSeq representing the object attributes to be returned.
orderByList--in OrderByItemSeq specifies which column(s) the results should be sorted by, and whether ascending or descending order is required.
uniqueByList--in UniqueByItemSeq specifies the column(s) used to identify and remove duplicate rows in the results.
NptException
Gets the object ID of the lister. Note that lister objects are not persistent. Use of this method should not be required in most situations.
ObjectId getObjectId() raises(NptException);
ObjectId representing the Object ID.
NptException
Provides the user with a mechanism for determining whether or not a set of actions is permitted.
void getPermittedActions(in ActionItemSeq actions, out PermissionItemSeq permission)
raises(NptException);
actions--in ActionItemSeq specifies the actions.
permission--out PermissionItemSeq specifies the permission.
NptException
Returns the reason why the action is not permitted.
string getReasonNotPermitted(in string actionName, out ErrorNumber number)
raises(NptException);
actionName--in string specifies the action name.
number--out ErrorNumber specifies the error number.
string
NptException
Provides the user with a mechanism for getting the subtypes associated with this object class. This method returns the list of subtypes and the object ID for a new object of each subtype.
void getSubtypes(out SubtypeItemSeq subtypeList)
raises(NptException);
subtypeList--out SubtypeItemSeq specifies the subtype list.
NptException
This is a generic method interface, behavior is instance specific.
void integratedRequest(in string command, in string inputParameter, out string outputParameter)
raises(NptException);
command--in string specifies the command.
inputParameter--in string specifies the input parameter, one input string parameter for the command.
outputParameter--out string specifies the output parameter, one output string parameter for the command.
NptException
This interface provides read access to the log files.
unsigned long read(in string fileName, in long seekOffset, in unsigned long nBytes, out charSeq data)
raises(NptException);
unsigned long readAudit(in long crId, in long seekOffset, in unsigned long nBytes, out charSeq data)
raises(NptException);
unsigned long readEvent(in long seekOffset, in unsigned long nBytes, out charSeq data)
raises(NptException);
unsigned long readSite(in long crId, in string siteName, in long seekOffset, in unsigned long nBytes, out charSeq data)
raises(NptException);
unsigned long readSiteError(in long crId, in string siteName, in long seekOffset, in unsigned long nBytes, out charSeq data)
raises(NptException);
unsigned long readSystemAdmin(in long seekOffset, in unsigned long nBytes, out charSeq data)
raises(NptException);
This interface provides access to the methods for reverting changes to an object and for getting the pending operation for an object.
Gets the pending operation for an object. For more information about Current and Pending views in the database, refer to the User's Guide.
PendingOperation getPendingOperation() raises(NptException);
PendingOperation
Provides the user with a mechanism for reverting changes to the object. An object reverts by deleting all of its pending records.
void revert(inout AttributeErrorItemSeq errorList)
raises(NptException,NptSaveException);
errorList--inout AttributeErrorItemSeq represents the error list. This is normally not used.
NptException NptSaveException
Internal use only.
Internal use only.
boolean isManagedComponent() raises(NptException);
Internal use only.
void okPartialSave(in PersistentId ownerObjectId)
raises(NptException);
Internal use only.
Internal use only.
ManagedComponent bindManagedComponent(in PersistentId id)
raises(NptException);
Internal use only.
ManagedComponentLister bindManagedComponentLister(in ObjectId id)
raises(NptException);
Internal use only.
ManagedComponent createManagedComponent(in ClassId nptClassName)
raises(NptException);
Internal use only.
ManagedComponentLister createManagedComponentLister(in ClassId nptClassName)
raises(NptException);
This interface is for internal use only.
This method is for internal use only.
PersistentId addElement(in AttributeValueItemSeq attributeList)
raises(NptException);
This method is for internal use only.
void removeElement(in PersistentId id)
raises(NptException);
Internal use only.
Internal use only.
Managed bindManaged(in PersistentId id)
raises(NptException);
Internal use only.
Managed createManaged(in ClassId nptClassName)
raises(NptException);
This interface provides access to the method for getting all attribute names.
Returns all attribute names for the specified class.
void getAllAttributeNames(in ClassId className, out AttributeItemSeq names)
raises(NptException);
className--in ClassId represents the classname, defined in the OAF.
names--out AttributeItemSeq represents the list of attribute names.
NptException
This interface provides access to the method for upload.
Internal use only.
void reload() raises(NptException);
Uploads the specified object and its contained objects into the database, given the upload information in parameters. This command returns only when the Upload Request has finished processing. If an error occurs, the Upload Request Object ID is set to "".
PersistentId upLoad(in UpLoadItemSeq parameters)
raises(NptException);
parameters--in UpLoadItemSeq represents the parameters - these are Equipment Module specific.
PersistentId
NptException
This interface provides access to the methods for creating and binding to network elements.
Passes an object id for the network element into the bind and it returns a CORBA object reference for the network element.
NetworkElement bindNetworkElement(in PersistentId id)
raises(NptException);
id--in PersistentId represents the persistent object ID.
NetworkElement
NptException
Provides the user with a mechanism for creating a network element.
NetworkElement createNetworkElement(in ClassId nptClassName)
raises(NptException);
nptClassName--in ClassId represents the classname, defined in the OAF.
NetworkElement
NptException
This interface provides access to the methods for manipulating persistent objects.
This is a generic method interface, behavior is instance specific.
void genericRequest(in string command, inout string parameters)
raises(NptException);
command--in string represents the command name.
parameters--inout string represents the parameters.
NptException
Provides the user with a mechanism for getting the values for a specified set of object attributes.
void getAttributes(in AttributeItemSeq attributes, out AttributeValueItemSeq results)
raises(NptException);
attributes--in AttributeItemSeq represents the attributes.
results--out AttributeValueItemSeq represents the results.
NptException
Provides the user with a mechanism for getting the values for a specified set of object attributes and their GUI modes.
void getAttributesAndGuiMode(in AttributeItemSeq attributes, out AttributeValueAndGuiModeItemSeq results)
raises(NptException);
attributes--in AttributeItemSeq represents the attributes.
results--out AttributeValueAndGuiModeItemSeq represents the results.
NptException
Provides the user with a mechanism for getting the values for a specified set of object attributes and their associated modes.
void getAttributesAndMode(in AttributeItemSeq attributes, out AttributeValueAndModeItemSeq results)
raises(NptException);
attributes--in AttributeItemSeq represents the attributes.
results--out AttributeValueAndModeItemSeq represents the results.
NptException
Gets the mode for the specified attribute. If the object has an associated profile, then the mode is defined by the profile for profiles attributes.
Mode getMode(in AttributeName attributeName)
raises(NptException);
attributeName--in AttributeName represents the attribute name.
Mode
NptException
Provides the user with a mechanism for determining whether or not a set of actions is permitted. This is typically used by viewers and scripters.
void getPermittedActions(in ActionItemSeq actions, out PermissionItemSeq permission)
raises(NptException);
actions--in ActionItemSeq represents the action.
permission--out PermissionItemSeq represents the permission.
NptException
Gets the persistent ID for the object.
PersistentId getPersistentId() raises(NptException);
PersistentId
NptException
Returns the reason why the action is not permitted.
string getReasonNotPermitted(in string actionName, out ErrorNumber number)
raises(NptException);
actionName--in string represents the name of the specified action (for example, getList action).
number--out ErrorNumber represents the error number.
string
NptException
Provides the user with a mechanism for undoing all setAttributes since the last save for this object. This method instructs the object to throw away changes that have not been saved.
string getTranslatedText(in string text)
raises(NptException);
text--in string represents the text string.
string
NptException
Gets the modified value of the specified attribute. The modified version is the version of the object in memory which has not yet been saved.
AttributeValue getValue(in AttributeName attributeName)
raises(NptGetValueException,NptException);
attributeName--in AttributeName represents the attribute name.
AttributeValue
NptGetValueException NptException
This is a generic method interface, behavior is instance specific.
void integratedRequest(in string command, in string inputParameter, out string outputParameter)
raises(NptException);
command--in string represents the command name.
inputParameter--in string represents the one input string parameter for the command.
outputParameter--out string represents the one output string parameter for the command.
NptException
Returns TRUE that this is a new object, or FALSE otherwise.
boolean isNew() raises(NptException);
boolean
NptException
Sets the values of the specified attributes without checking for the mode of the attributes.
void overwriteAttributes(in AttributeValueItemSeq attributeList)
raises(NptException);
attributeList--in AttributeValueItemSeq represents the attribute list.
NptException
Sets the values of the specified attributes without checking for mode of the attributes.
void overwriteValue(in AttributeName attributeName, in AttributeValue attributeValue)
raises(NptException);
attributeName--in AttributeName represents the attribute name.
attributeValue--in AttributeValue represents the attribute value.
NptException
Provides the user with a mechanism for removing (and deleting) the object. The errorList parameter is normally not used.
void remove(inout AttributeErrorItemSeq errorList)
raises(NptException,NptSaveException);
errorList--inout AttributeErrorItemSeq represents the error list.
NptException NptSaveException
Provides the user with a mechanism for saving all object changes to the database that were done with the setAttributes operation. The errorList parameter is normally not used.
void save(inout AttributeErrorItemSeq errorList)
raises(NptException,NptSaveException);
errorList--inout AttributeErrorItemSeq represents the error list.
NptException NptSaveException
Sets the association by criteria.
void setAssociationByCriteria(in AttributeName attributeName, in SearchItemSeq criteria)
raises(NptException);
attributeName--in AttributeName represents the attribute name.
criteria--in SearchItemSeq represents the criteria.
NptException
Sets the association by name.
void setAssociationByName(in AttributeName attributeName, in AttributeValue attributeValue)
raises(NptException);
attributeName--in AttributeName represents the attribute name.
attributeValue--in AttributeValue represents the attribute value.
NptException
Provides the user with a mechanism for setting the values for a specified set of object attributes. The values of attributes are set in memory but not into the database until a save is done.
void setAttributes(in AttributeValueItemSeq attributeList)
raises(NptException);
attributeList--in AttributeValueItemSeq represents the attribute list.
NptException
Sets the parent.
void setParent(in PersistentId parent)
raises(NptException);
parent--in PersistentId
NptException
Sets the value of the specified attribute.
void setValue(in AttributeName attributeName, in AttributeValue attributeValue)
raises(NptException);
attributeName--in AttributeName represents the attribute name.
attributeValue--in AttributeValue represents the attribute value.
NptException
Provides the user with a mechanism for undoing all setAttributes since the last save for this object. This method instructs the object to throw away changes that have not been saved.
void undo() raises(NptException);
NptException
This interface provides access to the methods for creating objects, and creating listers.
Passes an object id for the lister into the bind and it will return a CORBA object reference for the lister.
Lister bindLister(in ObjectId id)
raises(NptException);
id--in ObjectId represents the ID of the lister.
Lister
NptException
Passes an object id for the object into the bind and it will return a CORBA object reference for the object.
Persistent bindObject(in PersistentId id)
raises(NptException);
id--in PersistentId represents the ID of the object.
Persistent
NptException
Provides the user with a mechanism for creating a lister for the specified class name.
Lister createLister(in ClassId nptClassName)
raises(NptException);
nptClassName--in ClassId represents the classname, identified in the OAF.
Lister
NptException
Provides the user with a mechanism to create objects.
Persistent createObject(in ClassId nptClassName)
raises(NptException);
nptClassName--in ClassId represents the classname, defined in the OAF.
Persistent
NptException
Provides the user with a mechanism for creating a site item lister for the specified object ID.
SiteItemLister createSiteItemLister(in ObjectId coid)
raises(NptException);
coid--in ObjectId specifies the Transaction or Change Order object ID.
SiteItemLister
NptException
Returns the object class.
ClassId getObjectClass(in PersistentId id)
raises(NptException);
id--in PersistentId represents the ID of the object.
ClassId
NptException
This interface provides access to the methods for creating and managing sessions.
Returns the current Transaction object ID.
PersistentId getOpenCR() raises(NptException);
PersistentId representing the Transaction object ID.
NptException
Gets the list of services.
CosNaming::NamingContext getServices();
Returns the session ID as an integer.
DbId getSessionId();
DbId representing the session ID.
Ends the session.
void remove();
This interface provides access to the methods for creating a new and binding to an existing session.
Attaches to an existing session specifying the session object id.
Session attachMaster(in ObjectId sessionId)
raises(NptException);
sessionId--in ObjectId representing the session ID.
Session representing the session.
Attaches to an existing session specifying the session id as an integer.
Session attachMasterL(in long sessionId)
raises(NptException);
sessionId--in long representing the session ID.
Session representing the session.
NptException
Creates a session. The user name determines access privileges.
Session createMaster(in string userName, in string sessionType)
raises(NptException);
username--in string representing the username.
sessionType--in string representing the session type.
Session representing the session.
NptException
Internal use only.
Session createSession() raises(NptException);
This interface is derived from lister. It supports all of the methods defined for lister, plus the method for setting the Transaction.
Associate the site item lister with the specified Transaction.
void setCR(in PersistentId changeOrderId)
raises(NptException);
changeOrderId--in PersistentId specifies the ID of the Change Request.
NptException
This interface provides access to the methods for aborting an upload request.
Aborts an upload request that is running.
void abort() raises(NptException);
NptException
This interface provides access to the method for binding to an upload request.
Passes an object id for the upload request into the bind and it returns a CORBA object reference for the upload request.
UploadRequest bindUploadRequest(in PersistentId id)
raises(NptException);
id--in PersistentId represents the persistent object ID.
UploadRequest
NptException
Posted: Thu Aug 3 16:32:47 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.