source: ComponentRegistry/trunk/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/ComponentRegistry.java @ 207

package clarin.cmdi.componentregistry;

import java.io.IOException;
import java.security.Principal;
import java.util.List;

import clarin.cmdi.componentregistry.components.CMDComponentSpec;
import clarin.cmdi.componentregistry.model.ComponentDescription;
import clarin.cmdi.componentregistry.model.ProfileDescription;

public interface ComponentRegistry {

    public static final String REGISTRY_ID = "clarin.eu:cr1:";

    List<ComponentDescription> getComponentDescriptions();

    List<ProfileDescription> getProfileDescriptions();

    CMDComponentSpec getMDProfile(String id);

    CMDComponentSpec getMDComponent(String id);

    List<MDProfile> searchMDProfiles(String searchPattern);

    /**
     * 
     * @return -1 if profile could not be registered
     */
    int registerMDProfile(ProfileDescription description, CMDComponentSpec spec);

    int registerMDComponent(ComponentDescription description, CMDComponentSpec spec);

    String getMDProfileAsXml(String profileId);

    String getMDProfileAsXsd(String profileId);

    String getMDComponentAsXml(String componentId);

    String getMDComponentAsXsd(String componentId);

    /**
     * 
     * @param profileId
     * @param principal
     * @throws IOException
     * @throws UserUnauthorizedException thrown when principal does not match creator of profile
     */
    void deleteMDProfile(String profileId, Principal principal) throws IOException, UserUnauthorizedException;

    /**
     * 
     * @param componentId
     * @param principal
     * @throws IOException
     * @throws UserUnauthorizedException thrown when principal does not match creator of component
     */
    void deleteMDComponent(String componentId, Principal principal) throws IOException, UserUnauthorizedException;

    //getElements?
    //List<ConceptLinks> getConceptLinks(String componentId, String xpath); We only need xpath I think it contains the componentId's
}