TaskDescriptor.java

/*
 * 2012-3 Red Hat Inc. and/or its affiliates and other contributors.
 *
 * Licensed 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.
 */
package org.overlord.rtgov.call.trace.descriptors;

import org.overlord.rtgov.activity.model.ActivityType;

/**
 * This class provides a descriptor for activities that may be
 * presented within the call trace.
 *
 */
public interface TaskDescriptor {

    /**
     * This method determines if the descriptor
     * supports the specified activity type.
     * 
     * @param at The activity type
     * @return Whether the descriptor supports the type
     */
    public boolean isSupported(ActivityType at);
    
    /**
     * This method returns the description for
     * the supplied activity type.
     * 
     * @param at The activity type
     * @return The description
     */
    public String getDescription(ActivityType at);
    
}