Microsoft.Office.Server.ApplicationRegistry.Administration Namespace

  • Article

Allows the creation, reading, updating, and deletion of Business Data Catalog metadata objects in the Shared Services database.

The Administration object model has a relatively high latency and a delay of up to a minute before Business Data Catalog updates the cache in all the front-end Web and application servers in the deployment. Changes are immediate on the server where you make the change.

Developers and users of the Business Data Catalog administration user interface use the Administration object model to create and edit metadata.

Note

The MetadataModel namespace allows you only to read the metadata objects from the metadata database. The metadata database is cached and fast, so clients that just need to query the metadata database for metadata information should use the MetadataModel object model.

Classes

  Class Description
Public class AccessControlledMetadataObject Represents a Business Data Catalog metadata object whose access can be controlled by permissions. All 13 administration metadata objects and ApplicationRegistry inherit from this class and therefore can be controlled by permissions. This class cannot be instantiated.
Public class Action Represents an action in the Business Data Catalog.
Public class ActionCollection Represents a collection of Action objects. Provides methods for creating and enumerating actions for an entity.
Public class ActionParameter The URL attribute of the Action object can take parameters. The ActionParameter object defines the parameters the action URL accepts.
Public class ActionParameterCollection Represents a collection of ActionParameter objects.
Public class ApplicationRegistry Provides access to all of the line-of-business (LOB) systems and LOB system instances registered in the Business Data Catalog. This is the top-level object in the Business Data Catalog's object model. It is the entry point for you to create, read, update and delete all the metadata objects including LobSystem, Entity and Method. The ApplicationRegistry object has its own ACL and a user should at least have the Edit right on it to create a new LobSystem.
Public class Association Represents a relationship between two or more related entities.
Public class AssociationCollection Represents a collection of Association objects in a Business Data Catalog application.
Public class ConcurrentModificationException The Business Data Catalog administration object model uses an optimistic concurrency model. Each object has a version associated with it in memory. When it is written to disk via an Update, the version number in memory is compared with the version on disk, and is incremented if they are the same. The update is failed by throwing this Exception if they differ; the user must .Read() the object from disk, discarding the current in memory changes and then retry the update.
Public class DuplicateMetadataObjectException This exception is thrown if you try to create a metadata object and an object with the same name already exists in the Business Data Catalog.
Public class Entity Represents an entity such as a customer or sales order that is registered in the Business Data Catalog.
Public class EntityCollection Represents a collection of Entity objects. Provides methods to create and enumerate entities.
Public class ExceededMetadataObjectLimitException This exception is thrown when the metadata object limit is exceeded.
Public class FilterDescriptor Filters are the fundamental way in which the Business Data Catalog captures user (or system) input and plumbs it through to the backend API invocation. FilterDescriptors describe where in a complex series of parameters, a filter value should be inserted. This is accomplished by 'tagging' the TypeDescriptors representing complex parameters of a Method definition to flag where the insertion should happen. It is important to note that the backend must supply the functionality for filtering; the FilterDescriptors merely form a mechanism to surface this to the end user. FilterDescriptor objects are owned (contained) inside Method objects. They are subsequently referred by TypeDescriptor objects.
Public class FilterDescriptorCollection Represents a collection of FilterDescriptor objects.
Public class Identifier Represents the persistent identity of entity instances. You can use the key to search for a specific entity instance or a group of entity instances of that entity by using the Business Data Catalog.
Public class IdentifierCollection Represents a collection of Identifier objects.
Public class IndividuallySecurableMetadataObject Represents a metadata object whose access can be individually controlled. Only LobSystem, Entity, Method, and MethodInstance objects are individually securable. The other metadata objects rely on their individually securable ancestor to propagate the permissions to them. This class cannot be instantiated.
Public class InvalidMetadataObjectException This exception is thrown if the metadata object you are trying to access or create is invalid.
Public class InvalidMetadataPropertyException This exception is thrown if a metadata property is invalid.
Public class LobSystem Represents a business application registered in the Business Data Catalog.
Public class LobSystemCollection Represents a collection of LobSystem objects. Provides methods to create and enumerate LobSystem objects.
Public class LobSystemInstance Represents an instance of a business application registered in the Business Data Catalog.
Public class LobSystemInstanceCollection Represents a collection of LOBSystemInstance objects. Provides methods to create and enumerate LOBSystemInstance objects.
Public class LocalizedName Represents the string representation of a metadata object in a particular locale.
Public class LocalizedNameCollection Represents a collection of localized names.
Public class MetadataException Represents an exception thrown by a metadata object.
Public class MetadataObject Represents the abstract base class of the 13 metadata objects in the Business Data Catalog.
Public class MetadataObjectNotFoundException This exception is thrown if the requested metadata object cannot be found in the Business Data Catalog.
Public class Method Represents operations related to an entity that you can perform in the line-of-business (LOB) application.
Public class MethodCollection Represents a collection of methods. Provides methods to create and enumerate Method objects.
Public class MethodInstance Describes how to call a method. It is a reference to a method, plus the default values for the input parameters the method takes.
Public class MethodInstanceCollection Represents a collection of MethodInstance objects. Provides methods to create and enumerate MethodInstance objects.
Public class PackageFormatException This exception is thrown if there is an error in the XML of the package.
Public class Parameter Represents the in, inout, out and return parameters of each method.
Public class ParameterCollection Represents a collection of Parameter objects. Provides methods to create and enumerate Parameter objects.
Public class ParseContext Stores parse state that is shared across multiple metadata objects while reading or importing objects.
Public class ProfileLocationUndefinedException This exception is thrown if the profile location is undefined in the Business Data Catalog.
Public class ProfileProvisionException This exception is thrown if there was an error while provisioning the profile page.
Public class Property Properties are typed values associated with metadata objects. Some properties control the behavior of the Business Data Catalog; others enhance features based on the Business Data Catalog such as Business Data Web Parts or business data in lists. Properties used by Microsoft Office SharePoint Server 2007 are documented under the relevant metadata object.
Public class PropertyCollection Represents a collection of Property objects.
Public class TypeDescriptor Defines the data type of a parameter for a method.
Public class TypeDescriptorCollection Represents a collection of TypeDescriptor objects. Provides methods to create and enumerate TypeDescriptor objects.
Public class View A View denotes the schema, or the set of fields contained by an Entity Instance.

Enumerations

  Enumeration Description
Public enumeration PackageContents Represents the type of information that needs to be imported into the metadata repository or read from XML.