C# Class OSAE.OSAEObjectTypeManager

The class is used to manage OSA ObjectTypes

Datei anzeigen Open project: opensourceautomation/Open-Source-Automation Class Usage Examples

Public Methods

Method	Description
ObjectTypeAdd ( string Name, string Description, string OwnedBy, string BaseType, bool TypeOwner, bool SystemType, bool Container, bool HideRedundantEvents ) : void	Create new object type
ObjectTypeClone ( string NewObjectTypeName, string BaseObjectTypeName ) : void	Object type Clone
ObjectTypeDelete ( string Name ) : void	Delete an object type
ObjectTypeEventAdd ( string ObjectType, string Name, string Label, string tooltip ) : void	Add an event top an existing object type
ObjectTypeEventDelete ( string Name, string ObjectType ) : void	Delete an event from an object type
ObjectTypeEventUpdate ( string oldName, string newName, string label, string objectType, string tooltip ) : void	Update an existing event on an object type
ObjectTypeExists ( string name ) : bool
ObjectTypeExport ( string ObjectTypeName ) : string	Get Export script for object type
ObjectTypeLoad ( string name ) : OSAEObjectType	Loads the requested object Type
ObjectTypeMethodAdd ( string ObjectType, string Name, string Label, string ParamLabel1, string ParamLabel2, string ParamDefault1, string ParamDefault2, string tooltip ) : void	Add a method to an object type
ObjectTypeMethodDelete ( string Name, string ObjectType ) : void	Delete a method from an object type
ObjectTypeMethodExists ( string typeName, string methodName ) : bool
ObjectTypeMethodUpdate ( string oldName, string newName, string label, string objectType, string paramLabel1, string paramLabel2, string ParamDefault1, string ParamDefault2, string tooltip ) : void	Update an existing method on an object type
ObjectTypePropertyAdd ( string ObjectType, string Name, string ParameterType, string ParameterObjectType, string ParameterDefault, bool TrackHistory, bool Required, string tooltip ) : void	Add a property to an object type
ObjectTypePropertyDelete ( string Name, string ObjectType ) : void	Delete a property from on object type
ObjectTypePropertyOptionAdd ( string objectType, string propertyName, string option ) : void
ObjectTypePropertyOptionDelete ( string objectType, string propertyName, string option ) : void
ObjectTypePropertyOptionUpdate ( string objectType, string propertyName, string newoption, string oldoption ) : void
ObjectTypePropertyUpdate ( string oldName, string newName, string ParameterType, string ParameterObjectType, string ParameterDefault, string objectType, bool TrackHistory, bool Required, string tooltip ) : void	Update an existing property on an object type
ObjectTypeStateAdd ( string ObjectType, string Name, string Label, string tooltip ) : void	Add a state to an object type
ObjectTypeStateDelete ( string Name, string ObjectType ) : void	Delete a state from an object type
ObjectTypeStateUpdate ( string oldName, string newName, string newLabel, string objectType, string tooltip ) : void	Update an existing state from an object type
ObjectTypeUpdate ( string oldName, string newName, string Description, string OwnedBy, string BaseType, bool TypeOwner, bool SystemType, bool Container, bool HideRedundantEvents, string Tooltip ) : void	Update an existing object type

Method Details

ObjectTypeAdd() public static method

Create new object type

public static ObjectTypeAdd ( string Name, string Description, string OwnedBy, string BaseType, bool TypeOwner, bool SystemType, bool Container, bool HideRedundantEvents ) : void
Name	string	The name of the new object type
Description	string	The description of the new object type
OwnedBy	string	Who the new object type is owned by
BaseType	string	The base type of the new object
TypeOwner	bool
SystemType	bool
Container	bool	The container for the new object type
HideRedundantEvents	bool
return	void

ObjectTypeClone() public static method

Object type Clone

public static ObjectTypeClone ( string NewObjectTypeName, string BaseObjectTypeName ) : void
NewObjectTypeName	string
BaseObjectTypeName	string
return	void

ObjectTypeDelete() public static method

Delete an object type

public static ObjectTypeDelete ( string Name ) : void
Name	string
return	void

ObjectTypeEventAdd() public static method

Add an event top an existing object type

public static ObjectTypeEventAdd ( string ObjectType, string Name, string Label, string tooltip ) : void
ObjectType	string
Name	string
Label	string
tooltip	string
return	void

ObjectTypeEventDelete() public static method

Delete an event from an object type

public static ObjectTypeEventDelete ( string Name, string ObjectType ) : void
Name	string
ObjectType	string
return	void

ObjectTypeEventUpdate() public static method

Update an existing event on an object type

public static ObjectTypeEventUpdate ( string oldName, string newName, string label, string objectType, string tooltip ) : void
oldName	string
newName	string
label	string
objectType	string
tooltip	string
return	void

ObjectTypeExists() public static method

public static ObjectTypeExists ( string name ) : bool
name	string
return	bool

ObjectTypeExport() public static method

Get Export script for object type

public static ObjectTypeExport ( string ObjectTypeName ) : string
ObjectTypeName	string
return	string

ObjectTypeLoad() public static method

Loads the requested object Type

public static ObjectTypeLoad ( string name ) : OSAEObjectType
name	string	The name of the object type to load
return	OSAEObjectType

ObjectTypeMethodAdd() public static method

Add a method to an object type

public static ObjectTypeMethodAdd ( string ObjectType, string Name, string Label, string ParamLabel1, string ParamLabel2, string ParamDefault1, string ParamDefault2, string tooltip ) : void
ObjectType	string
Name	string
Label	string
ParamLabel1	string
ParamLabel2	string
ParamDefault1	string
ParamDefault2	string
tooltip	string
return	void

ObjectTypeMethodDelete() public static method

Delete a method from an object type

public static ObjectTypeMethodDelete ( string Name, string ObjectType ) : void
Name	string
ObjectType	string
return	void

ObjectTypeMethodExists() public static method

public static ObjectTypeMethodExists ( string typeName, string methodName ) : bool
typeName	string
methodName	string
return	bool

ObjectTypeMethodUpdate() public static method

Update an existing method on an object type

public static ObjectTypeMethodUpdate ( string oldName, string newName, string label, string objectType, string paramLabel1, string paramLabel2, string ParamDefault1, string ParamDefault2, string tooltip ) : void
oldName	string
newName	string
label	string
objectType	string
paramLabel1	string
paramLabel2	string
ParamDefault1	string
ParamDefault2	string
tooltip	string
return	void

ObjectTypePropertyAdd() public static method

Add a property to an object type

public static ObjectTypePropertyAdd ( string ObjectType, string Name, string ParameterType, string ParameterObjectType, string ParameterDefault, bool TrackHistory, bool Required, string tooltip ) : void
ObjectType	string
Name	string
ParameterType	string
ParameterObjectType	string
ParameterDefault	string
TrackHistory	bool
Required	bool
tooltip	string
return	void

ObjectTypePropertyDelete() public static method

Delete a property from on object type

public static ObjectTypePropertyDelete ( string Name, string ObjectType ) : void
Name	string
ObjectType	string
return	void

ObjectTypePropertyOptionAdd() public static method

public static ObjectTypePropertyOptionAdd ( string objectType, string propertyName, string option ) : void
objectType	string
propertyName	string
option	string
return	void

ObjectTypePropertyOptionDelete() public static method

public static ObjectTypePropertyOptionDelete ( string objectType, string propertyName, string option ) : void
objectType	string
propertyName	string
option	string
return	void

ObjectTypePropertyOptionUpdate() public static method

public static ObjectTypePropertyOptionUpdate ( string objectType, string propertyName, string newoption, string oldoption ) : void
objectType	string
propertyName	string
newoption	string
oldoption	string
return	void

ObjectTypePropertyUpdate() public static method

Update an existing property on an object type

public static ObjectTypePropertyUpdate ( string oldName, string newName, string ParameterType, string ParameterObjectType, string ParameterDefault, string objectType, bool TrackHistory, bool Required, string tooltip ) : void
oldName	string
newName	string
ParameterType	string
ParameterObjectType	string
ParameterDefault	string
objectType	string
TrackHistory	bool
Required	bool
tooltip	string
return	void

ObjectTypeStateAdd() public static method

Add a state to an object type

public static ObjectTypeStateAdd ( string ObjectType, string Name, string Label, string tooltip ) : void
ObjectType	string
Name	string
Label	string
tooltip	string
return	void

ObjectTypeStateDelete() public static method

Delete a state from an object type

public static ObjectTypeStateDelete ( string Name, string ObjectType ) : void
Name	string
ObjectType	string
return	void

ObjectTypeStateUpdate() public static method

Update an existing state from an object type

public static ObjectTypeStateUpdate ( string oldName, string newName, string newLabel, string objectType, string tooltip ) : void
oldName	string
newName	string
newLabel	string
objectType	string
tooltip	string
return	void

ObjectTypeUpdate() public static method

Update an existing object type

public static ObjectTypeUpdate ( string oldName, string newName, string Description, string OwnedBy, string BaseType, bool TypeOwner, bool SystemType, bool Container, bool HideRedundantEvents, string Tooltip ) : void
oldName	string	The old name of the object type
newName	string	The new name to be given to the object type
Description	string	The description for the object type
OwnedBy	string	Who owns the object type
BaseType	string
TypeOwner	bool
SystemType	bool
Container	bool	The container for the object type
HideRedundantEvents	bool
Tooltip	string
return	void