05 - SP3DNetAPI - Business Object
05 - SP3DNetAPI - Business Object
05 - SP3DNetAPI - Business Object
Net API
Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Basics Of Business Object - 1
Business Objects
Smart 3D Smart 3D
Pipeline UnitSystem Nozzle …
.Net API .Net API
PipeRun PipeSpec Support Space …
Business Objects Services
Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Basics Of Business Object - 2
Business Objects
• Abbreviated as BO. BusinessObjects are the engineering things like
Equipment, PipeRun, PipeFeature, ControlPoint and so on.
• A .Net BusinessObject is also referred to as Wrapper, as it essentially
wraps the Business Object and provides property/method access.
• For people who know Smart 3D COM object model, incidentally, this also
wraps the internal COM business object. The internal COM business
Object is never available, nor needed for end user’s usage in Smart 3D
.Net API.
• Provides many useful methods and properties, including generic access to
properties and relationships. (more on this in later session).
• The Basic Business object (BusinessObject) is the base class of all Smart 3D
Business objects in .Net API. It inherits from System.Object.
• Each Smart 3D business object is wrapped by a .Net BusinessObject. There
could be a specialized BO wrapper which offers more methods &
functionality, like a PipeRun or a Equipment Instance or a Catalog Part.
Wherever there is no Specialized BO Wrapper, the basic BusinessObject
provides the wrapper.
Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Basics Of Business Object - 3
Business Objects
AccessControl Gets AccessControl to current user
Business
Object ApprovalStatus Gets ApprovalStatus of the object
ClassInfo Gets ClassInfo (Metadata) of this object
DBConnection Gets Connection to which this BO belongs.
Delete() Deletes the Object (if permissions allow)
Equipment UnitSystem GetAllProperties Gets PropertyValue ReadOnlyCollection of all properties
PartClass Pipeline GetPropertyValue() Gets PropertyValue given Property Details
Filter PipeRun
SetPropertyValue() Sets PropertyValue given Property Details and value
GetRelationship () Gets RelationshipCollection given RelationshipInfo.
Part RouteFeature
IsTypeofBOC () Checks if this BO is of given BO Classification type.
Nozzle PipeSpec
Notes () Gets Notes associated with this BO (as ReadOnlyCollection).
Note Space
RemoveAllNotes () Removes all Notes associated with this BO.
WBSItem Line3D Removes a given Note object associated with this BO.
RemoveNote ()
Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Basics Of Business Object - 4
Business Objects
• As you can see, most of the information needed about a Business object is
available right at this level, and it serves such information for any kind of
Smart 3D object. For example…
– An object’s Object type, i.e. Class Information; Implemented Interfaces; Its BOC
classification; AccessControl to current user; whether or not it supports an
interface; its permission group; status; the connection to which it belongs;
property access – Get/Set; its ID in the database; its Related objects; its User
Class Information, its Notes etc.
• Some more information is just one step away, for example, to get related
objects given a relationship & Role names is just one step away… (we will
learn about Relationships and Related objects in a later session)
• For people who know Smart 3D COM object model, all this information was
scattered over different interfaces – which was so to take benefit of the
COM methodology of partitioning data & information on various interfaces.
• It is a great advantage in Smart 3D .Net API to have easy access to all such
important information. This greatly reduces the number of lines you have
to write to perform common tasks like get/set properties, access relations,
metadata, access control and many more.
Smart 3D .Net API Training – © 2018. Hexagon PPM. All Rights Reserved.
Basics Of Business Object - 5