server/src/main/java/org/apache/abdera/protocol/server/WorkspaceInfo.java

/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements.  The ASF licenses this file to You
* under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.  For additional information regarding
* copyright in this work, please see the NOTICE file in the top level
* directory of this distribution.
*/
package org.apache.abdera.protocol.server;

import java.util.Collection;

import org.apache.abdera.model.Workspace;

/**
 * Metadata interface used by WorkspaceManager and Provider 
 * implementations to construct Atompub Service Documents.
 * 
 * The WorkspaceInfo interface provides information used to
 * construct an app:workspace element 
 */
public interface WorkspaceInfo {

  /**
   * Return the value of the app:workspace element's atom:title. This assumes
   * that the atom:title element uses type="text". This must not be null
   */
  String getTitle(RequestContext requsest);
  
  /**
   * Return the listing of collections available as part of the workspace
   */
  Collection<CollectionInfo> getCollections(RequestContext request);
  
  /**
   * Returns an instance of the FOM Workspace interface
   */
  Workspace asWorkspaceElement(RequestContext request);
}